Skip to content

Commit

Permalink
Merge pull request #339 from GillesPy2/develop
Browse files Browse the repository at this point in the history
v1.4.0 Release
  • Loading branch information
briandrawert authored May 19, 2020
2 parents 6b20eef + ba23a9d commit a1d330a
Show file tree
Hide file tree
Showing 91 changed files with 22,519 additions and 7,207 deletions.
Binary file modified .graphics/gillespy2-UML-class-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions UML_CLASS_DIAGRAM.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ This diagram was built from a [UML class model](gillespy2-UML-class-model.pyns)

-GillesPySolver: a mathematical algorithm for running a Model object, creating a Results object containing simulation data.

-Results: a dictionary containing data from a simulation trajectory generated by running a Model via a solver.
-Trajectory: a dictionary containing data from a simulation trajectory generated by running a Model via a solver.

-EnsembleResults: a list of data dictionaries from multiple trajectories generated by running the same Model over multiple instances.
-Results: a list of data dictionaries from one or more trajectories generated by running the same Model over multiple instances.

![gillespy2-UML-class-diagram](.graphics/gillespy2-UML-class-diagram.png)
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 90a763d479747475ebce9163f6d985c4
config: 80c92b260bd66298b23222542d9d1bb0
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/build/html/.doctrees/classes/gillespy2.core.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/classes/gillespy2.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/classes/gillespy2.sbml.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/classes/gillespy2.solvers.auto.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/classes/gillespy2.solvers.cpp.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/classes/gillespy2.solvers.cython.doctree
Binary file not shown.
Binary file modified docs/build/html/.doctrees/classes/gillespy2.solvers.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/html/.doctrees/tutorials/tut_sbml/tut_sbml.doctree
Binary file not shown.
Binary file not shown.
1,379 changes: 1,379 additions & 0 deletions docs/build/html/_modules/collections.html

Large diffs are not rendered by default.

519 changes: 519 additions & 0 deletions docs/build/html/_modules/contextlib.html

Large diffs are not rendered by default.

343 changes: 343 additions & 0 deletions docs/build/html/_modules/gillespy2/core/events.html

Large diffs are not rendered by default.

526 changes: 389 additions & 137 deletions docs/build/html/_modules/gillespy2/core/gillespy2.html

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion docs/build/html/_modules/gillespy2/core/gillespyError.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>gillespy2.core.gillespyError &#8212; GillesPy2 1.3.0 documentation</title>
<title>gillespy2.core.gillespyError &#8212; GillesPy2 1.4.0 documentation</title>
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/gillespy2_alabaster_customizations.css" />
Expand Down Expand Up @@ -154,6 +154,13 @@ <h1>Source code for gillespy2.core.gillespyError</h1><div class="highlight"><pre

<div class="viewcode-block" id="EventError"><a class="viewcode-back" href="../../../classes/gillespy2.core.html#gillespy2.core.gillespyError.EventError">[docs]</a><span class="k">class</span> <span class="nc">EventError</span><span class="p">(</span><span class="n">ModelError</span><span class="p">):</span>
<span class="k">pass</span></div>

<span class="c1">#Results errors</span>
<div class="viewcode-block" id="ResultsError"><a class="viewcode-back" href="../../../classes/gillespy2.core.html#gillespy2.core.gillespyError.ResultsError">[docs]</a><span class="k">class</span> <span class="nc">ResultsError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="k">pass</span></div>

<div class="viewcode-block" id="ValidationError"><a class="viewcode-back" href="../../../classes/gillespy2.core.html#gillespy2.core.gillespyError.ValidationError">[docs]</a><span class="k">class</span> <span class="nc">ValidationError</span><span class="p">(</span><span class="n">ResultsError</span><span class="p">):</span>
<span class="k">pass</span></div>
</pre></div>

</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>gillespy2.core.gillespySolver &#8212; GillesPy2 1.3.0 documentation</title>
<title>gillespy2.core.gillespySolver &#8212; GillesPy2 1.4.0 documentation</title>
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/gillespy2_alabaster_customizations.css" />
Expand Down
456 changes: 209 additions & 247 deletions docs/build/html/_modules/gillespy2/core/results.html

Large diffs are not rendered by default.

468 changes: 0 additions & 468 deletions docs/build/html/_modules/gillespy2/example_models.html

This file was deleted.

4 changes: 3 additions & 1 deletion docs/build/html/_modules/gillespy2/sbml/SBMLimport.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>gillespy2.sbml.SBMLimport &#8212; GillesPy2 1.3.0 documentation</title>
<title>gillespy2.sbml.SBMLimport &#8212; GillesPy2 1.4.0 documentation</title>
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/gillespy2_alabaster_customizations.css" />
Expand Down Expand Up @@ -449,6 +449,8 @@ <h1>Source code for gillespy2.sbml.SBMLimport</h1><div class="highlight"><pre>
<div class="viewcode-block" id="convert"><a class="viewcode-back" href="../../../classes/gillespy2.sbml.html#gillespy2.sbml.SBMLimport.convert">[docs]</a><span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">model_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">gillespy_model</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>

<span class="n">sbml_model</span><span class="p">,</span> <span class="n">errors</span> <span class="o">=</span> <span class="n">__read_sbml_model</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sbml_model</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span><span class="p">,</span> <span class="n">errors</span>
<span class="k">if</span> <span class="n">model_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">model_name</span> <span class="o">=</span> <span class="n">sbml_model</span><span class="o">.</span><span class="n">getName</span><span class="p">()</span>
<span class="k">if</span> <span class="n">gillespy_model</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
Expand Down
161 changes: 161 additions & 0 deletions docs/build/html/_modules/gillespy2/solvers/cpp/example_models.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>gillespy2.solvers.cpp.example_models &#8212; GillesPy2 1.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/gillespy2_alabaster_customizations.css" />
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />

<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />

<link rel="apple-touch-icon" href="../../../../_static/img/gillespy2-logo.svg" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>
<div class="document">

<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="../../../../index.html">
<img class="logo" src="../../../../_static/img/gillespy2-logo.svg" alt="Logo"/>

</a>
</p>






<p>
<iframe src="https://ghbtns.com/github-btn.html?user=GillesPy2&repo=GillesPy2&type=watch&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>





<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Getting started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started/installation/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started/basic_usage/basic_usage.html">Basic usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorials/tut_toggle_switch/tut_toggle_switch.html">Tutorial: ODE vs. SSA</a></li>
</ul>
<p class="caption"><span class="caption-text">API reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../classes/gillespy2.html">gillespy2 package</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../../../index.html">Documentation overview</a><ul>
<li><a href="../../../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>








</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<h1>Source code for gillespy2.solvers.cpp.example_models</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">gillespy2.core</span> <span class="k">import</span> <span class="n">Model</span><span class="p">,</span> <span class="n">Species</span><span class="p">,</span> <span class="n">Reaction</span><span class="p">,</span> <span class="n">Parameter</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>


<div class="viewcode-block" id="Example"><a class="viewcode-back" href="../../../../classes/gillespy2.solvers.cpp.html#gillespy2.solvers.cpp.example_models.Example">[docs]</a><span class="k">class</span> <span class="nc">Example</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This is a simple example for mass-action degradation of species S.</span>
<span class="sd"> &quot;&quot;&quot;</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">parameter_values</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># Initialize the model.</span>
<span class="n">Model</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Example&quot;</span><span class="p">)</span>
<span class="c1"># Species</span>
<span class="n">S</span> <span class="o">=</span> <span class="n">Species</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;Sp&#39;</span><span class="p">,</span> <span class="n">initial_value</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_species</span><span class="p">([</span><span class="n">S</span><span class="p">])</span>
<span class="c1"># Parameters</span>
<span class="n">k1</span> <span class="o">=</span> <span class="n">Parameter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;k1&#39;</span><span class="p">,</span> <span class="n">expression</span><span class="o">=</span><span class="mf">3.0</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_parameter</span><span class="p">([</span><span class="n">k1</span><span class="p">])</span>
<span class="c1"># Reactions</span>
<span class="n">rxn1</span> <span class="o">=</span> <span class="n">Reaction</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;S degradation&#39;</span><span class="p">,</span> <span class="n">reactants</span><span class="o">=</span><span class="p">{</span><span class="n">S</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span> <span class="n">products</span><span class="o">=</span><span class="p">{},</span> <span class="n">rate</span><span class="o">=</span><span class="n">k1</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_reaction</span><span class="p">([</span><span class="n">rxn1</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timespan</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">101</span><span class="p">))</span></div>


<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Trichloroethylene&#39;</span><span class="p">,</span> <span class="s1">&#39;LacOperon&#39;</span><span class="p">,</span> <span class="s1">&#39;Schlogl&#39;</span><span class="p">,</span> <span class="s1">&#39;MichaelisMenten&#39;</span><span class="p">,</span>
<span class="s1">&#39;ToggleSwitch&#39;</span><span class="p">,</span> <span class="s1">&#39;Example&#39;</span><span class="p">,</span> <span class="s1">&#39;Tyson2StateOscillator&#39;</span><span class="p">,</span> <span class="s1">&#39;Oregonator&#39;</span><span class="p">]</span>
</pre></div>

</div>
<div class="related bottom">
&nbsp;
<nav id="rellinks">
<ul>
</ul>
</nav>
</div>

</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;Copyright (C) 2017-2020.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>


<a href="https://github.com/GillesPy2/GillesPy2" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>



</body>
</html>
Loading

0 comments on commit a1d330a

Please sign in to comment.