build based on adcb9ba

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-02-12T14:17:00","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-02-15T00:05:07","documenter_version":"1.2.1"}}

dev/api/solvers/diffeq/index.html

@@ -6,4 +6,4 @@
     output_func=(sol, i) -> CryoGridOutput(sol),
     reduction=(u,data,i) -> (append!(u,data),false),
     ensprob_kwargs...
-)</code></pre><p>Constructs an <code>EnsembleProblem</code> for a <code>m x N</code> parameter matrix <code>Θ</code>, where <code>N</code> is the size of the ensemble and <code>m</code> is the dimensionality of the ensmeble parameter space (e.g. the number of parameters). <code>transform</code> should be a transform function that accepts an <code>m</code>-dimensional vector and produces a parameter vector (or <code>CryoGridParams</code> instance) which matches the output of <code>CryoGrid.parameters</code>. By default, <code>param_map</code> is the identity function; however, it may be customized to permit the construction of reduced-rank or reparameterized ensembles for which the parameter space differs from the full CryoGrid model parameter space.</p><p>Keyword arguments:</p><p><code>output_func</code>: a function <code>(sol,i)::Any</code> which processes the <code>ODESolution</code> for ensemble member <code>i</code> and returns the result. It is recommended to save output to disk for non-trivial time spans to avoid slowdowns from serialization time when running the ensemble using parallel workers.</p><p><code>reduction</code>: a function <code>(u,data,i)</code> which accumulates the result of <code>output_func</code> in <code>u</code>. Defaults to just appending <code>data</code> to <code>u</code>.</p><p><code>output_dir</code>: Only used to specify the output directory for the default implementation of <code>output_func</code>. If a custom <code>output_func</code> is provided, this arugment is ignored.</p><p>All additional keyword arguments will be passed to <code>EnsembleProblem</code>.</p><p>See also <a href="@ref"><code>SciMLBase.EnsembleProblem</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CryoGrid/CryoGrid.jl/blob/a0c60aaa5a25b47f767757b61b3272b46278d59b/src/Solvers/DiffEq/ensemble.jl#L1-L32">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../basic_solvers/">« Built-in</a><a class="docs-footer-nextpage" href="../lite_implicit/">CryoGridLite »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Monday 12 February 2024 14:16">Monday 12 February 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+)</code></pre><p>Constructs an <code>EnsembleProblem</code> for a <code>m x N</code> parameter matrix <code>Θ</code>, where <code>N</code> is the size of the ensemble and <code>m</code> is the dimensionality of the ensmeble parameter space (e.g. the number of parameters). <code>transform</code> should be a transform function that accepts an <code>m</code>-dimensional vector and produces a parameter vector (or <code>CryoGridParams</code> instance) which matches the output of <code>CryoGrid.parameters</code>. By default, <code>param_map</code> is the identity function; however, it may be customized to permit the construction of reduced-rank or reparameterized ensembles for which the parameter space differs from the full CryoGrid model parameter space.</p><p>Keyword arguments:</p><p><code>output_func</code>: a function <code>(sol,i)::Any</code> which processes the <code>ODESolution</code> for ensemble member <code>i</code> and returns the result. It is recommended to save output to disk for non-trivial time spans to avoid slowdowns from serialization time when running the ensemble using parallel workers.</p><p><code>reduction</code>: a function <code>(u,data,i)</code> which accumulates the result of <code>output_func</code> in <code>u</code>. Defaults to just appending <code>data</code> to <code>u</code>.</p><p><code>output_dir</code>: Only used to specify the output directory for the default implementation of <code>output_func</code>. If a custom <code>output_func</code> is provided, this arugment is ignored.</p><p>All additional keyword arguments will be passed to <code>EnsembleProblem</code>.</p><p>See also <a href="@ref"><code>SciMLBase.EnsembleProblem</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CryoGrid/CryoGrid.jl/blob/adcb9ba41885af6f847173a64090d200e7b2ecc5/src/Solvers/DiffEq/ensemble.jl#L1-L32">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../basic_solvers/">« Built-in</a><a class="docs-footer-nextpage" href="../lite_implicit/">CryoGridLite »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 15 February 2024 00:05">Thursday 15 February 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>