build based on c518f65

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.2","generation_timestamp":"2024-08-28T15:38:29","documenter_version":"1.6.0"}}
+{"documenter":{"julia_version":"1.9.2","generation_timestamp":"2024-08-28T15:43:28","documenter_version":"1.6.0"}}

dev/index.html

@@ -4,4 +4,4 @@
 Pkg.add(url=&quot;https://github.com/Alseidon/TaylorInterface.jl&quot;)</code></pre><p>You also need the taylor tool installed to use this package. You can find it <a href="https://github.com/joang/taylor2-dist">here (latest version)</a> or install it by running:</p><pre><code class="language-bash hljs">curl -sS https://web.ma.utexas.edu/repos/deb/taylor.gpg.key | gpg --dearmor | sudo tee /usr/share/keyrings/taylor.gpg
 echo &quot;deb [signed-by=/usr/share/keyrings/taylor.gpg] http://web.ma.utexas.edu/repos/deb focal main&quot; | sudo tee /etc/apt/sources.list.d/taylor.list
 sudo apt update
-sudo apt install taylor</code></pre><p>Now, you might either want to take a look at the <a href="quickstart/#quickstart">quick start</a> or begin with the full <a href="introduction/#introduction">introduction</a>, dive into the <a href="internals/#internals">internal machinery</a> of <code>TaylorInterface.jl</code>, or simply search the <a href="fulldocs/#fulldocs">full docs</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quickstart/">Quick start »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:38">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+sudo apt install taylor</code></pre><p>Now, you might either want to take a look at the <a href="quickstart/#quickstart">quick start</a> or begin with the full <a href="introduction/#introduction">introduction</a>, dive into the <a href="internals/#internals">internal machinery</a> of <code>TaylorInterface.jl</code>, or simply search the <a href="fulldocs/#fulldocs">full docs</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quickstart/">Quick start »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:43">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/internals/index.html

@@ -70,4 +70,4 @@
  1: ok, and ti=endtime.  
 -1: not ok, unable to compute step size.  double_log  underflow/overflow</code></pre><p>You can use it directly (it is included in the <code>lib.so</code>), but it requires some initialisation beforehand if jet transport is at play, or if the number type isn&#39;t double. taylor defines the <code>InitMyFloat(x)</code> function to initialize any <code>MY_FLOAT</code> variable. For jet transport, you need to call <code>taylor_initialize_jet_library()</code> before using it, and <code>InitJet(x)</code> on your jet variables. You can refer to <code>wrapper.h</code> for an example of the latter case.</p><h3 id="wrapping_funcs"><a class="docs-heading-anchor" href="#wrapping_funcs">The wrapping functions</a><a id="wrapping_funcs-1"></a><a class="docs-heading-anchor-permalink" href="#wrapping_funcs" title="Permalink"></a></h3><p><code>TaylorInterface.jl</code> adds some convenience functions in the wrapper. First are two simplified versions of <code>taylor_step_auto</code>: <code>tstep</code> and <code>tstep_reverse</code> (respectively when <code>*endtime</code> is positive or negative)</p><pre><code class="language-C hljs">int tstep(MY_FLOAT *ti, MY_FLOAT *x, double log10err, MY_FLOAT *endtime);
 
-int tstep_reverse(MY_FLOAT *ti, MY_FLOAT *x, double log10err, MY_FLOAT *endtime);</code></pre><p>They simply hide some of <code>taylor_step_auto</code>&#39;s parameters, and regroup <code>log10abserr</code> and <code>log10relerr</code>.</p><p>Finally, we include a Poincaré map from 0. to <code>endtime</code>:</p><pre><code class="language-C hljs">void flow(double endtime, MY_FLOAT *x, MY_FLOAT *y, MY_FLOAT *df);</code></pre><p>Where <code>x</code> is the initial state, <code>y</code> stores the final state and <code>df</code> stores the non-zero degree jet transport values.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../speed/">« Compared benchmark</a><a class="docs-footer-nextpage" href="../fulldocs/">Full documentation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:38">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+int tstep_reverse(MY_FLOAT *ti, MY_FLOAT *x, double log10err, MY_FLOAT *endtime);</code></pre><p>They simply hide some of <code>taylor_step_auto</code>&#39;s parameters, and regroup <code>log10abserr</code> and <code>log10relerr</code>.</p><p>Finally, we include a Poincaré map from 0. to <code>endtime</code>:</p><pre><code class="language-C hljs">void flow(double endtime, MY_FLOAT *x, MY_FLOAT *y, MY_FLOAT *df);</code></pre><p>Where <code>x</code> is the initial state, <code>y</code> stores the final state and <code>df</code> stores the non-zero degree jet transport values.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../speed/">« Compared benchmark</a><a class="docs-footer-nextpage" href="../fulldocs/">Full documentation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:43">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/introduction/index.html

@@ -37,4 +37,4 @@
 plot(times, positions, label="positions")
 plot!(times, velocities, label="velocities")
 xlabel!("\\\$t\\\$")
-show()</code></pre><p>And thus, you can see nice 2π-periodic oscillations.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../quickstart/">« Quick start</a><a class="docs-footer-nextpage" href="../speed/">Compared benchmark »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:38">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+show()</code></pre><p>And thus, you can see nice 2π-periodic oscillations.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../quickstart/">« Quick start</a><a class="docs-footer-nextpage" href="../speed/">Compared benchmark »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:43">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/quickstart/index.html

@@ -27,4 +27,4 @@
 
 flow!(handler, in, out, 1., jacobian) # ccall inside
 
-reshape(jacobian, (2, 2))</code></pre><p>And finally, we can close our library:</p><pre><code class="language-julia hljs">close_lib(handler)</code></pre><p>If we don&#39;t need the directory anymore, we can delete it:</p><pre><code class="language-julia hljs">TaylorInterface.clear_dir(handler) # TaylorInterface.clear_dir(generator) also works</code></pre><h2 id="Default-models"><a class="docs-heading-anchor" href="#Default-models">Default models</a><a id="Default-models-1"></a><a class="docs-heading-anchor-permalink" href="#Default-models" title="Permalink"></a></h2><p>We propose some default models that come with the package; you can get them with</p><pre><code class="language-julia hljs">get_model(modelname)</code></pre><p>At the moment, we propose:</p><ul><li><code>rpb_sun_earth</code>, the restricted three-body problem for the Sun+Earth system, in synodic (co-rotating) coordinates, assuming circular motion</li><li><code>bcp_sun_earth_jupiter</code> and <code>bcp_sun_earth_venus</code>, where we add a perturbation from a planet in circular motion either Jupiter or Venus (the model is called bicircular)</li><li><code>rpb_SE_nojet</code>, the same problem as the first, but whereas for the three other cases we computed first-order variational equations, here we remove jet transport for speed.</li></ul><p>Note that you will need to compile the model with <code>compile_eqs(handler)</code> in order to use it.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../introduction/">Introduction »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:38">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+reshape(jacobian, (2, 2))</code></pre><p>And finally, we can close our library:</p><pre><code class="language-julia hljs">close_lib(handler)</code></pre><p>If we don&#39;t need the directory anymore, we can delete it:</p><pre><code class="language-julia hljs">TaylorInterface.clear_dir(handler) # TaylorInterface.clear_dir(generator) also works</code></pre><h2 id="Default-models"><a class="docs-heading-anchor" href="#Default-models">Default models</a><a id="Default-models-1"></a><a class="docs-heading-anchor-permalink" href="#Default-models" title="Permalink"></a></h2><p>We propose some default models that come with the package; you can get them with</p><pre><code class="language-julia hljs">get_model(modelname)</code></pre><p>At the moment, we propose:</p><ul><li><code>rpb_sun_earth</code>, the restricted three-body problem for the Sun+Earth system, in synodic (co-rotating) coordinates, assuming circular motion</li><li><code>bcp_sun_earth_jupiter</code> and <code>bcp_sun_earth_venus</code>, where we add a perturbation from a planet in circular motion either Jupiter or Venus (the model is called bicircular)</li><li><code>rpb_SE_nojet</code>, the same problem as the first, but whereas for the three other cases we computed first-order variational equations, here we remove jet transport for speed.</li></ul><p>Note that you will need to compile the model with <code>compile_eqs(handler)</code> in order to use it.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../introduction/">Introduction »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Wednesday 28 August 2024 15:43">Wednesday 28 August 2024</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>