Auto-update from Github Actions Workflow

Deployed from commit 139d8db (refs/tags/v3.0.0a3)
bmcage · Jul 14, 2024 · 4452951 · 4452951
1 parent 87db350
commit 4452951
Show file tree

Hide file tree

Showing 55 changed files with 14,320 additions and 1 deletion.
diff --git a/v3.0.0a3/_modules/index.html b/v3.0.0a3/_modules/index.html
@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; Odes 3.0.0a3 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
+    <link rel="stylesheet" type="text/css" href="../_static/badge_only.css?v=cf56f567" />
+    <script src="../_static/jquery.js?v=5d32c60e"></script>
+    <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+    <script src="../_static/documentation_options.js?v=178a9fdf"></script>
+    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/docs-versions-menu.js?v=45d24689"></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" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="scikits_odes/dae.html">scikits_odes.dae</a></li>
+<li><a href="scikits_odes/dopri5.html">scikits_odes.dopri5</a></li>
+<li><a href="scikits_odes/ode.html">scikits_odes.ode</a></li>
+<li><a href="scikits_odes/odeint.html">scikits_odes.odeint</a></li>
+<li><a href="scikits_odes_core.html">scikits_odes_core</a></li>
+<li><a href="scikits_odes_sundials.html">scikits_odes_sundials</a></li>
+<ul><li><a href="scikits_odes_sundials/cvode.html">scikits_odes_sundials.cvode</a></li>
+<li><a href="scikits_odes_sundials/ida.html">scikits_odes_sundials.ida</a></li>
+</ul></ul>
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">Odes</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../ode.html">ODE Solvers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../dae.html">DAE Solvers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../sundials.html">Sundials Solver Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">Lower Level API</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2016, B. Malengier.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/v3.0.0a3/_modules/scikits_odes/dae.html b/v3.0.0a3/_modules/scikits_odes/dae.html
diff --git a/v3.0.0a3/_modules/scikits_odes/dopri5.html b/v3.0.0a3/_modules/scikits_odes/dopri5.html
diff --git a/v3.0.0a3/_modules/scikits_odes/ode.html b/v3.0.0a3/_modules/scikits_odes/ode.html
diff --git a/v3.0.0a3/_modules/scikits_odes/odeint.html b/v3.0.0a3/_modules/scikits_odes/odeint.html
diff --git a/v3.0.0a3/_modules/scikits_odes_core.html b/v3.0.0a3/_modules/scikits_odes_core.html
diff --git a/v3.0.0a3/_modules/scikits_odes_sundials.html b/v3.0.0a3/_modules/scikits_odes_sundials.html
@@ -0,0 +1,195 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>scikits_odes_sundials &#8212; Odes 3.0.0a3 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
+    <link rel="stylesheet" type="text/css" href="../_static/badge_only.css?v=cf56f567" />
+    <script src="../_static/jquery.js?v=5d32c60e"></script>
+    <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+    <script src="../_static/documentation_options.js?v=178a9fdf"></script>
+    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/docs-versions-menu.js?v=45d24689"></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" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <h1>Source code for scikits_odes_sundials</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">SUNDIALS wrapper</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="kn">import</span> <span class="nn">inspect</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">_version</span>
+<span class="n">__version__</span> <span class="o">=</span> <span class="n">_version</span><span class="o">.</span><span class="n">get_versions</span><span class="p">()[</span><span class="s1">&#39;version&#39;</span><span class="p">]</span>
+
+
+<div class="viewcode-block" id="CVODESolveException">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.CVODESolveException">[docs]</a>
+<span class="k">class</span> <span class="nc">CVODESolveException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class for exceptions raised by ``CVODE.validate_flags``.&quot;&quot;&quot;</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">soln</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">soln</span> <span class="o">=</span> <span class="n">soln</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">soln</span><span class="p">),)</span></div>
+
+
+<div class="viewcode-block" id="CVODESolveFailed">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.CVODESolveFailed">[docs]</a>
+<span class="k">class</span> <span class="nc">CVODESolveFailed</span><span class="p">(</span><span class="n">CVODESolveException</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;``CVODE.solve`` failed to reach endpoint&quot;&quot;&quot;</span>
+    <span class="n">_message</span> <span class="o">=</span> <span class="p">(</span>
+        <span class="s2">&quot;Solver failed with flag </span><span class="si">{0.flag}</span><span class="s2"> and finished at </span><span class="si">{0.errors.t}</span><span class="s2">&quot;</span>
+        <span class="s2">&quot;with values </span><span class="si">{0.errors.y}</span><span class="s2">.&quot;</span>
+    <span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="CVODESolveFoundRoot">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.CVODESolveFoundRoot">[docs]</a>
+<span class="k">class</span> <span class="nc">CVODESolveFoundRoot</span><span class="p">(</span><span class="n">CVODESolveException</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;``CVODE.solve`` found a root&quot;&quot;&quot;</span>
+    <span class="n">_message</span> <span class="o">=</span> <span class="s2">&quot;Solver found a root at </span><span class="si">{0.roots.t[0]}</span><span class="s2">.&quot;</span></div>
+
+
+<div class="viewcode-block" id="CVODESolveReachedTSTOP">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.CVODESolveReachedTSTOP">[docs]</a>
+<span class="k">class</span> <span class="nc">CVODESolveReachedTSTOP</span><span class="p">(</span><span class="n">CVODESolveException</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;``CVODE.solve`` reached the endpoint specified by tstop.&quot;&quot;&quot;</span>
+    <span class="n">_message</span> <span class="o">=</span> <span class="s2">&quot;Solver reached tstop at </span><span class="si">{0.tstop.t[0]}</span><span class="s2">.&quot;</span></div>
+
+
+<div class="viewcode-block" id="IDASolveException">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.IDASolveException">[docs]</a>
+<span class="k">class</span> <span class="nc">IDASolveException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class for exceptions raised by ``IDA.validate_flags``.&quot;&quot;&quot;</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">soln</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">soln</span> <span class="o">=</span> <span class="n">soln</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">soln</span><span class="p">),)</span></div>
+
+
+<div class="viewcode-block" id="IDASolveFailed">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.IDASolveFailed">[docs]</a>
+<span class="k">class</span> <span class="nc">IDASolveFailed</span><span class="p">(</span><span class="n">IDASolveException</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;``IDA.solve`` failed to reach endpoint&quot;&quot;&quot;</span>
+    <span class="n">_message</span> <span class="o">=</span> <span class="p">(</span>
+        <span class="s2">&quot;Solver failed with flag </span><span class="si">{0.flag}</span><span class="s2"> and finished at </span><span class="si">{0.errors.t}</span><span class="s2">&quot;</span>
+        <span class="s2">&quot;with values </span><span class="si">{0.errors.y}</span><span class="s2"> and derivatives </span><span class="si">{0.errors.ydot}</span><span class="s2">.&quot;</span>
+    <span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="IDASolveFoundRoot">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.IDASolveFoundRoot">[docs]</a>
+<span class="k">class</span> <span class="nc">IDASolveFoundRoot</span><span class="p">(</span><span class="n">IDASolveException</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;``IDA.solve`` found a root&quot;&quot;&quot;</span>
+    <span class="n">_message</span> <span class="o">=</span> <span class="s2">&quot;Solver found a root at </span><span class="si">{0.roots.t[0]}</span><span class="s2">.&quot;</span></div>
+
+
+<div class="viewcode-block" id="IDASolveReachedTSTOP">
+<a class="viewcode-back" href="../api/sundials.html#scikits_odes_sundials.IDASolveReachedTSTOP">[docs]</a>
+<span class="k">class</span> <span class="nc">IDASolveReachedTSTOP</span><span class="p">(</span><span class="n">IDASolveException</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;``IDA.solve`` reached the endpoint specified by tstop.&quot;&quot;&quot;</span>
+    <span class="n">_message</span> <span class="o">=</span> <span class="s2">&quot;Solver reached tstop at </span><span class="si">{0.tstop.t[0]}</span><span class="s2">.&quot;</span></div>
+
+
+
+<span class="k">def</span> <span class="nf">_get_num_args</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Python 2/3 compatible method of getting number of args that `func` accepts</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">inspect</span><span class="p">,</span> <span class="s2">&quot;getfullargspec&quot;</span><span class="p">):</span>
+        <span class="n">argspec</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getfullargspec</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="n">argspec</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getargspec</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
+    <span class="n">arg_cnt</span> <span class="o">=</span> <span class="mi">0</span>
+    <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">argspec</span><span class="o">.</span><span class="n">args</span><span class="p">:</span>
+        <span class="k">if</span> <span class="n">arg</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;self&quot;</span><span class="p">,</span> <span class="s2">&quot;cls&quot;</span><span class="p">):</span>
+            <span class="n">arg_cnt</span> <span class="o">+=</span> <span class="mi">1</span>
+    <span class="k">return</span> <span class="n">arg_cnt</span>
+</pre></div>
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">Odes</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../ode.html">ODE Solvers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../dae.html">DAE Solvers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../sundials.html">Sundials Solver Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">Lower Level API</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>
+<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2016, B. Malengier.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/v3.0.0a3/_sources/api/compat.rst.txt b/v3.0.0a3/_sources/api/compat.rst.txt
@@ -0,0 +1,47 @@
+scikits.odes
+============
+
+scikits.odes
+------------
+.. automodule:: scikits.odes
+    :members:
+
+scikits.odes.ode
+----------------
+.. automodule:: scikits.odes.ode
+    :members:
+
+scikits.odes.dae
+----------------
+.. automodule:: scikits.odes.dae
+    :members:
+
+scikits.odes.dopri5
+--------------------
+.. automodule:: scikits.odes.dopri5
+    :members:
+
+scikits.odes.ddaspkint
+----------------------
+.. automodule:: scikits.odes.ddaspkint
+    :members:
+
+scikits.odes.lsodiint
+---------------------
+.. automodule:: scikits.odes.lsodiint
+    :members:
+
+scikits.odes.sundials
+---------------------
+.. automodule:: scikits.odes.sundials
+    :members:
+
+scikits.odes.sundials.cvode
+---------------------------
+.. automodule:: scikits.odes.sundials.cvode
+    :members:
+
+scikits.odes.sundials.ida
+-------------------------
+.. automodule:: scikits.odes.sundials.ida
+    :members:
diff --git a/v3.0.0a3/_sources/api/core.rst.txt b/v3.0.0a3/_sources/api/core.rst.txt
@@ -0,0 +1,5 @@
+scikits-odes-core
+-----------------
+
+.. automodule:: scikits_odes_core
+    :members:
diff --git a/v3.0.0a3/_sources/api/daepack.rst.txt b/v3.0.0a3/_sources/api/daepack.rst.txt
@@ -0,0 +1,12 @@
+scikits-odes-daepack
+====================
+
+.. scikits_odes_daepack.ddaspkint
+.. ------------------------------
+.. .. automodule:: scikits_odes_daepack.ddaspkint
+..     :members:
+.. 
+.. scikits_odes_daepack.lsodiint
+.. -----------------------------
+.. .. automodule:: scikits_odes_daepack.lsodiint
+..     :members:
diff --git a/v3.0.0a3/_sources/api/index.rst.txt b/v3.0.0a3/_sources/api/index.rst.txt
@@ -0,0 +1,11 @@
+Lower Level API
+===============
+
+.. toctree::
+   :maxdepth: 2
+
+   core
+   daepack
+   sundials
+   main
+   compat