Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@JamesPHoughton
JamesPHoughton committed Jun 23, 2015
1 parent aa77f76 commit 771a24a
Show file tree
Hide file tree
Showing 20 changed files with 686 additions and 382 deletions.
Binary file modified docs/_build/doctrees/development/internal_functions.doctree
View file
Binary file not shown.
Binary file added docs/_build/doctrees/development/translation.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/functions.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
6 changes: 5 additions & 1 deletion docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../functions.html">User Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../translation.html">Translation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development/developer.html">Developer Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/developer.html#motivation-the-coming-of-age-of-big-data">Motivation: The (coming of) age of Big Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/developer.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
Expand All @@ -110,6 +109,11 @@
<li class="toctree-l2"><a class="reference internal" href="../development/internal_functions.html#building-the-python-model-file">Building the python model file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../development/translation.html">Translation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/translation.html#types">Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/translation.html#functions">Functions</a></li>
</ul>
</li>
</ul>


Expand Down
232 changes: 136 additions & 96 deletions docs/_build/html/_modules/pysd/builder/builder.html
View file

Large diffs are not rendered by default.

39 changes: 27 additions & 12 deletions docs/_build/html/_modules/pysd/functions/functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../functions.html">User Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../development/developer.html">Developer Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../development/developer.html#motivation-the-coming-of-age-of-big-data">Motivation: The (coming of) age of Big Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../development/developer.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
Expand All @@ -111,6 +110,11 @@
<li class="toctree-l2"><a class="reference internal" href="../../../development/internal_functions.html#building-the-python-model-file">Building the python model file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../development/translation.html">Translation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../development/translation.html#types">Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../development/translation.html#functions">Functions</a></li>
</ul>
</li>
</ul>


Expand Down Expand Up @@ -153,7 +157,7 @@ <h1>Source code for pysd.functions.functions</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">scipy.stats</span> <span class="kn">as</span> <span class="nn">stats</span>


<div class="viewcode-block" id="Functions"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions">[docs]</a><span class="k">class</span> <span class="nc">Functions</span><span class="p">():</span>
<div class="viewcode-block" id="Functions"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions">[docs]</a><span class="k">class</span> <span class="nc">Functions</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component_class</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">components</span> <span class="o">=</span> <span class="n">component_class</span>
Expand All @@ -165,38 +169,49 @@ <h1>Source code for pysd.functions.functions</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">val_if_true</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">val_if_false</span>
</div>

</div>
<div class="viewcode-block" id="Functions.step"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions.step">[docs]</a> <span class="k">def</span> <span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">tstep</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;&quot; Impliments vensim&#39;s STEP function</span>
<span class="sd"> </span>
<span class="sd"> In range [-inf, tstep) returns 0</span>
<span class="sd"> In range [tstep, +inf] returns `value`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">t</span>
<span class="k">return</span> <span class="n">value</span> <span class="k">if</span> <span class="n">t</span> <span class="o">&gt;=</span><span class="n">tstep</span> <span class="k">else</span> <span class="mi">0</span>

</div>
<div class="viewcode-block" id="Functions.pulse"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions.pulse">[docs]</a> <span class="k">def</span> <span class="nf">pulse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">duration</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Implements vensim&#39;s PULSE function</span>
<span class="sd"> </span>
<span class="sd"> In range [-inf, start) returns 0</span>
<span class="sd"> In range [start, start+duration) returns 1</span>
<span class="sd"> In range [start+duration, +inf] returns 0</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">t</span>
<span class="k">return</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">t</span><span class="o">&gt;=</span><span class="n">start</span> <span class="ow">and</span> <span class="n">t</span><span class="o">&lt;</span><span class="n">start</span><span class="o">+</span><span class="n">duration</span> <span class="k">else</span> <span class="mi">0</span>
<span class="k">return</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">t</span> <span class="o">&gt;=</span> <span class="n">start</span> <span class="ow">and</span> <span class="n">t</span> <span class="o">&lt;</span> <span class="n">start</span><span class="o">+</span><span class="n">duration</span> <span class="k">else</span> <span class="mi">0</span>

<span class="c"># Warning: I&#39;m not totally sure if this is correct</span></div>
<div class="viewcode-block" id="Functions.pulse_train"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions.pulse_train">[docs]</a> <span class="k">def</span> <span class="nf">pulse_train</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">duration</span><span class="p">,</span> <span class="n">repeattime</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">t</span>
<span class="k">return</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">t</span><span class="o">&gt;=</span><span class="n">start</span> <span class="ow">and</span> <span class="p">(</span><span class="n">t</span><span class="o">-</span><span class="n">start</span><span class="p">)</span><span class="o">%</span><span class="n">repeattime</span> <span class="o">&lt;</span> <span class="n">duration</span> <span class="k">else</span> <span class="mi">0</span>
<span class="k">return</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">t</span> <span class="o">&gt;=</span> <span class="n">start</span> <span class="ow">and</span> <span class="p">(</span><span class="n">t</span><span class="o">-</span><span class="n">start</span><span class="p">)</span><span class="o">%</span><span class="n">repeattime</span> <span class="o">&lt;</span> <span class="n">duration</span> <span class="k">else</span> <span class="mi">0</span>
</div>
<div class="viewcode-block" id="Functions.ramp"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions.ramp">[docs]</a> <span class="k">def</span> <span class="nf">ramp</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slope</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">finish</span><span class="p">):</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">t</span>
<span class="k">if</span> <span class="n">t</span><span class="o">&lt;</span><span class="n">start</span><span class="p">:</span>
<span class="k">if</span> <span class="n">t</span> <span class="o">&lt;</span> <span class="n">start</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">0</span>
<span class="k">elif</span> <span class="n">t</span><span class="o">&gt;</span><span class="n">finish</span><span class="p">:</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">&gt;</span> <span class="n">finish</span><span class="p">:</span>
<span class="k">return</span> <span class="n">slope</span> <span class="o">*</span> <span class="p">(</span><span class="n">start</span><span class="o">-</span><span class="n">finish</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">slope</span> <span class="o">*</span> <span class="p">(</span><span class="n">t</span><span class="o">-</span><span class="n">start</span><span class="p">)</span>
</div>
</div>
<div class="viewcode-block" id="Functions.bounded_normal"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions.bounded_normal">[docs]</a> <span class="k">def</span> <span class="nf">bounded_normal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">minimum</span><span class="p">,</span> <span class="n">maximum</span><span class="p">,</span> <span class="n">mean</span><span class="p">,</span> <span class="n">std</span><span class="p">,</span> <span class="n">seed</span><span class="p">):</span>
<span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
<span class="k">return</span> <span class="n">stats</span><span class="o">.</span><span class="n">truncnorm</span><span class="o">.</span><span class="n">rvs</span><span class="p">(</span><span class="n">minimum</span><span class="p">,</span> <span class="n">maximum</span><span class="p">,</span> <span class="n">loc</span><span class="o">=</span><span class="n">mean</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="n">std</span><span class="p">)</span>
</div>
</div>
<div class="viewcode-block" id="Functions.lookup"><a class="viewcode-back" href="../../../development/internal_functions.html#pysd.functions.Functions.lookup">[docs]</a> <span class="k">def</span> <span class="nf">lookup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">xs</span><span class="p">,</span> <span class="n">ys</span><span class="p">):</span>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">interp</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">xs</span><span class="p">,</span> <span class="n">ys</span><span class="p">)</span></div></div>
</pre></div>
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">interp</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">xs</span><span class="p">,</span> <span class="n">ys</span><span class="p">)</span>
</pre></div></div></div>

</div>
<footer>
Expand Down

0 comments on commit 771a24a

Please sign in to comment.