Skip to content

Commit

Permalink
Update Sphinx documentation, commit a8fbce7 [skip ci].
Browse files Browse the repository at this point in the history
  • Loading branch information
bluescarni committed Oct 20, 2023
1 parent 83291d9 commit d0413b3
Show file tree
Hide file tree
Showing 22 changed files with 313 additions and 285 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
9 changes: 9 additions & 0 deletions _sources/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
Changelog
=========

3.0.1 (unreleased)
------------------

Fix
~~~

- Fix building against Python 3.12
(`#139 <https://github.com/bluescarni/heyoka.py/pull/139>`__).

3.0.0 (2023-10-07)
------------------

Expand Down
484 changes: 251 additions & 233 deletions changelog.html

Large diffs are not rendered by default.

41 changes: 21 additions & 20 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -501,30 +501,31 @@ <h1>heyoka.py<a class="headerlink" href="#heyoka-py" title="Permalink to this he
</li>
<li class="toctree-l1"><a class="reference internal" href="benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">3.0.1 (unreleased)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">3.0.0 (2023-10-07)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">2.0.0 (2023-09-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">1.0.0 (2023-08-11)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.21.8 (2023-07-03)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">0.21.7 (2023-02-16)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">0.20.0 (2022-12-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id15">0.19.0 (2022-09-19)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id18">0.18.0 (2022-05-11)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id22">0.17.0 (2022-01-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id26">0.16.0 (2021-11-20)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id29">0.15.1 (2021-10-10)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id31">0.15.0 (2021-09-28)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id35">0.14.0 (2021-08-03)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id38">0.12.0 (2021-07-23)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id41">0.11.0 (2021-07-06)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id44">0.10.0 (2021-06-09)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id47">0.9.0 (2021-05-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id50">0.8.0 (2021-04-28)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id53">0.7.0 (2021-04-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id56">0.6.1 (2021-04-08)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id59">0.6.0 (2021-04-06)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id63">0.5.0 (2021-02-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id66">0.4.0 (2021-02-20)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id69">0.3.0 (2021-02-13)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">0.21.7 (2023-02-16)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id12">0.20.0 (2022-12-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">0.19.0 (2022-09-19)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id19">0.18.0 (2022-05-11)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id23">0.17.0 (2022-01-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id27">0.16.0 (2021-11-20)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id30">0.15.1 (2021-10-10)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id32">0.15.0 (2021-09-28)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id36">0.14.0 (2021-08-03)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id39">0.12.0 (2021-07-23)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id42">0.11.0 (2021-07-06)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id45">0.10.0 (2021-06-09)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id48">0.9.0 (2021-05-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id51">0.8.0 (2021-04-28)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id54">0.7.0 (2021-04-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id57">0.6.1 (2021-04-08)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id60">0.6.0 (2021-04-06)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id64">0.5.0 (2021-02-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id67">0.4.0 (2021-02-20)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id70">0.3.0 (2021-02-13)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="breaking_changes.html">Breaking changes</a><ul>
Expand Down
2 changes: 1 addition & 1 deletion notebooks/Batch mode overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -1320,7 +1320,7 @@ <h2>Ensemble propagations<a class="headerlink" href="#ensemble-propagations" tit
</div>
</div>
<div class="cell_output docutils container">
<img alt="../_images/576fc5460baeab671c712015524dbba12c07a42a92e188b218ead3abbc33e1c3.png" src="../_images/576fc5460baeab671c712015524dbba12c07a42a92e188b218ead3abbc33e1c3.png" />
<img alt="../_images/2e9fb5ec637c5e1f5fe3f8f4cc2c8d41a5883d437ab02b66316c4ce00ae853e3.png" src="../_images/2e9fb5ec637c5e1f5fe3f8f4cc2c8d41a5883d437ab02b66316c4ce00ae853e3.png" />
</div>
</div>
</section>
Expand Down
8 changes: 4 additions & 4 deletions notebooks/Customising the adaptive integrator.html
Original file line number Diff line number Diff line change
Expand Up @@ -574,8 +574,8 @@ <h2>Compact mode<a class="headerlink" href="#compact-mode" title="Permalink to t
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 6.23 s, sys: 62.3 ms, total: 6.29 s
Wall time: 6.29 s
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 5.73 s, sys: 70.5 ms, total: 5.8 s
Wall time: 5.8 s
</pre></div>
</div>
</div>
Expand All @@ -590,8 +590,8 @@ <h2>Compact mode<a class="headerlink" href="#compact-mode" title="Permalink to t
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 238 ms, sys: 7 µs, total: 238 ms
Wall time: 237 ms
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 200 ms, sys: 0 ns, total: 200 ms
Wall time: 200 ms
</pre></div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1036,9 +1036,9 @@ <h2>Implementing a single shooting method<a class="headerlink" href="#implementi
</div>
</div>
<div class="cell_output docutils container">
<div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>/tmp/ipykernel_13156/2332358995.py:11: DeprecationWarning: Conversion of an array with ndim &gt; 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)
<div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>/tmp/ipykernel_7782/2332358995.py:11: DeprecationWarning: Conversion of an array with ndim &gt; 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)
ta.pars[6] = np.heaviside(switching_function(x_0,y_0,lx_0,ly_0, ps), 1.)
/tmp/ipykernel_13156/2332358995.py:14: DeprecationWarning: Conversion of an array with ndim &gt; 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)
/tmp/ipykernel_7782/2332358995.py:14: DeprecationWarning: Conversion of an array with ndim &gt; 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)
ta.state[0] = x_0; ta.state[1] = y_0; ta.state[2] = lx_0; ta.state[3] = ly_0
</pre></div>
</div>
Expand Down Expand Up @@ -1080,7 +1080,7 @@ <h2>Implementing a single shooting method<a class="headerlink" href="#implementi
</div>
</div>
<div class="cell_output docutils container">
<div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>/tmp/ipykernel_13156/685660463.py:12: DeprecationWarning: Conversion of an array with ndim &gt; 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)
<div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>/tmp/ipykernel_7782/685660463.py:12: DeprecationWarning: Conversion of an array with ndim &gt; 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)
ta.pars[6] = np.heaviside(switching_function(x_0,y_0,lx_0,ly_0, ps), 1.)
</pre></div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions notebooks/Periodic orbits in the CR3BP.html
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,7 @@ <h2>Putting all together and integrating some initial conditions<a class="header
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>--- 13.76629114151001 seconds --- to build the Taylor integrator
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>--- 13.201801776885986 seconds --- to build the Taylor integrator
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -706,7 +706,7 @@ <h2>Putting all together and integrating some initial conditions<a class="header
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>--- 0.05161547660827637 seconds --- to propagate
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>--- 0.05413055419921875 seconds --- to propagate
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -764,7 +764,7 @@ <h2>Putting all together and integrating some initial conditions<a class="header
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.collections.PathCollection at 0x7f43cc116d70&gt;
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.collections.PathCollection at 0x7fb3881e74c0&gt;
</pre></div>
</div>
<img alt="../_images/9980640d13156b473c62a3e3b7e03a3e55926a455c595779849b49a9c3082370.png" src="../_images/9980640d13156b473c62a3e3b7e03a3e55926a455c595779849b49a9c3082370.png" />
Expand Down
10 changes: 5 additions & 5 deletions notebooks/ensemble_mode.html
Original file line number Diff line number Diff line change
Expand Up @@ -575,11 +575,11 @@ <h2>A simple example<a class="headerlink" href="#a-simple-example" title="Permal
Taylor order : 20
Dimension : 2
Time : 20
State : [0.05274957217287761, 0.058994169278669774],
State : [0.04033817408663731, 0.04912585974412174],
&lt;taylor_outcome.time_limit: -4294967299&gt;,
0.19787796709340139,
0.22023660740842543,
98,
0.20846134993777574,
0.2209875521521299,
94,
None)
</pre></div>
</div>
Expand Down Expand Up @@ -630,7 +630,7 @@ <h2>A simple example<a class="headerlink" href="#a-simple-example" title="Permal
</div>
</div>
<div class="cell_output docutils container">
<img alt="../_images/fa978776a1c075026ee667abf2bc6072332a765e944e93bc28236e19049395bc.png" src="../_images/fa978776a1c075026ee667abf2bc6072332a765e944e93bc28236e19049395bc.png" />
<img alt="../_images/1dfc6ec1d3b3ffed1b2af2d09e554fa19f5980d0d988a584836a564586e0e929.png" src="../_images/1dfc6ec1d3b3ffed1b2af2d09e554fa19f5980d0d988a584836a564586e0e929.png" />
</div>
</div>
</section>
Expand Down
16 changes: 8 additions & 8 deletions notebooks/jit_caching.html
Original file line number Diff line number Diff line change
Expand Up @@ -441,8 +441,8 @@ <h1>JIT compilation and caching<a class="headerlink" href="#jit-compilation-and-
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 77 ms, sys: 4.51 ms, total: 81.5 ms
Wall time: 81.6 ms
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 94.6 ms, sys: 2.96 ms, total: 97.6 ms
Wall time: 97.5 ms
</pre></div>
</div>
</div>
Expand All @@ -455,8 +455,8 @@ <h1>JIT compilation and caching<a class="headerlink" href="#jit-compilation-and-
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 3.74 ms, sys: 0 ns, total: 3.74 ms
Wall time: 2.87 ms
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 4.65 ms, sys: 0 ns, total: 4.65 ms
Wall time: 4.24 ms
</pre></div>
</div>
</div>
Expand All @@ -470,8 +470,8 @@ <h1>JIT compilation and caching<a class="headerlink" href="#jit-compilation-and-
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 15.5 ms, sys: 0 ns, total: 15.5 ms
Wall time: 14.9 ms
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 22.9 ms, sys: 232 µs, total: 23.1 ms
Wall time: 22.4 ms
</pre></div>
</div>
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>(&lt;taylor_outcome.time_limit: -4294967299&gt;,
Expand All @@ -498,8 +498,8 @@ <h1>JIT compilation and caching<a class="headerlink" href="#jit-compilation-and-
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 1.71 ms, sys: 0 ns, total: 1.71 ms
Wall time: 1.11 ms
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 1.59 ms, sys: 0 ns, total: 1.59 ms
Wall time: 1.1 ms
</pre></div>
</div>
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>(&lt;taylor_outcome.time_limit: -4294967299&gt;,
Expand Down
6 changes: 3 additions & 3 deletions notebooks/second_integral.html
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,7 @@ <h2>Running the experiments<a class="headerlink" href="#running-the-experiments"
</div>
</div>
<div class="cell_output docutils container">
<img alt="../_images/31eaa409423dac75aa16fc84b918fca811b7e9bc694adb876acefba895cf755d.png" src="../_images/31eaa409423dac75aa16fc84b918fca811b7e9bc694adb876acefba895cf755d.png" />
<img alt="../_images/f59d171ccd85f003a1048038bc16f481ee58480856379dca79fd84c8ffaba449.png" src="../_images/f59d171ccd85f003a1048038bc16f481ee58480856379dca79fd84c8ffaba449.png" />
</div>
</div>
<p>This Poincare’ section is suggesting that the integral of motion <span class="math notranslate nohighlight">\(\mathcal{C}\)</span> does indeed exist, because the intersections of all random orbits are clearly tracing curves on the <span class="math notranslate nohighlight">\(x=0\)</span> plane.</p>
Expand All @@ -624,7 +624,7 @@ <h2>Running the experiments<a class="headerlink" href="#running-the-experiments"
</div>
</div>
<div class="cell_output docutils container">
<img alt="../_images/cd0cd555d5e9d7cb09b9c10a9192e94eeef9c425b2ce01af18c74a7170557d29.png" src="../_images/cd0cd555d5e9d7cb09b9c10a9192e94eeef9c425b2ce01af18c74a7170557d29.png" />
<img alt="../_images/89fb56372eeecb8598b78e805a70486c1836ac4ec1a248b902036e34fb507f89.png" src="../_images/89fb56372eeecb8598b78e805a70486c1836ac4ec1a248b902036e34fb507f89.png" />
</div>
</div>
<p>The qualitative picture is now radically different. Although islands of stable motion persist, now most trajectories seem to be densely filling the plane, rather than tracing curves on it. Let us further increase the energy level:</p>
Expand All @@ -635,7 +635,7 @@ <h2>Running the experiments<a class="headerlink" href="#running-the-experiments"
</div>
</div>
<div class="cell_output docutils container">
<img alt="../_images/caee1971c0c309d8ed677c7272a37a635271d98a4e5be290f84e48fae866c5d5.png" src="../_images/caee1971c0c309d8ed677c7272a37a635271d98a4e5be290f84e48fae866c5d5.png" />
<img alt="../_images/82c72eaef21f14a6c6743f1898bff751ce37be84267d42cc6dfe785f0f08d239.png" src="../_images/82c72eaef21f14a6c6743f1898bff751ce37be84267d42cc6dfe785f0f08d239.png" />
</div>
</div>
<p>At higher energies, the densely-filling behaviour (which Henon and Heiles call <em>ergodic</em>) is even more prevalent than before.</p>
Expand Down
8 changes: 4 additions & 4 deletions notebooks/sympy_interop.html
Original file line number Diff line number Diff line change
Expand Up @@ -598,8 +598,8 @@ <h1>Interoperability with SymPy<a class="headerlink" href="#interoperability-wit
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 2.11 s, sys: 0 ns, total: 2.11 s
Wall time: 2.11 s
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 2.66 s, sys: 0 ns, total: 2.66 s
Wall time: 2.66 s
</pre></div>
</div>
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>(&lt;taylor_outcome.time_limit: -4294967299&gt;,
Expand All @@ -618,8 +618,8 @@ <h1>Interoperability with SymPy<a class="headerlink" href="#interoperability-wit
</div>
</div>
<div class="cell_output docutils container">
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 2.23 s, sys: 0 ns, total: 2.23 s
Wall time: 2.23 s
<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>CPU times: user 2.34 s, sys: 1.61 ms, total: 2.34 s
Wall time: 2.34 s
</pre></div>
</div>
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>(&lt;taylor_outcome.time_limit: -4294967299&gt;,
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit d0413b3

Please sign in to comment.