build based on 826cd59

previews/PR322/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-05-19T15:07:45","documenter_version":"1.4.1"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-05-19T15:28:54","documenter_version":"1.4.1"}}

previews/PR322/index.html

@@ -277,4 +277,4 @@
   [3f19e933] p7zip_jll v17.4.0+2
 Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`</code></pre></details>You can also download the 
 <a href="">manifest</a> file and the
-<a href="">project</a> file.</article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/creating_ode/">Creating ODE System »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 19 May 2024 15:07">Sunday 19 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<a href="">project</a> file.</article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/creating_ode/">Creating ODE System »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 19 May 2024 15:28">Sunday 19 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR322/input/input/index.html

@@ -9,10 +9,10 @@
     x1'(t) = a * x1(t) + u(t),
     x2'(t) = b * x2(t) + c*x1(t)*x2(t),
     y(t) = x1(t)
-)</code></pre><p>Here,</p><ul><li><code>x1</code>, <code>x2</code> are state variables</li><li><code>y</code> is an output variable</li><li><code>u</code> is an input variable</li><li><code>a</code>, <code>b</code>, <code>c</code> are time-independent parameters</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/a7867a5c159d10ce9b15e2b7336bbafe6b32d3b6/src/input_macro.jl#L242-L268">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.ODE" href="#StructuralIdentifiability.ODE"><code>StructuralIdentifiability.ODE</code></a> — <span class="docstring-category">Type</span></header><section><div><p>The main structure that represents input ODE system.</p><p>Stores information about states (<code>x_vars</code>), outputs (<code>y_vars</code>), inputs (<code>u_vars</code>), parameters (<code>parameters</code>) and the equations.</p><p>This structure is constructed via <code>@ODEmodel</code> macro.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/a7867a5c159d10ce9b15e2b7336bbafe6b32d3b6/src/ODE.jl#L1-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.set_parameter_values" href="#StructuralIdentifiability.set_parameter_values"><code>StructuralIdentifiability.set_parameter_values</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set_parameter_values(ode, param_values)</code></pre><p>Input:</p><ul><li><code>ode</code> - an ODE as above</li><li><code>param_values</code> - values for (possibly, some of) the parameters as dictionary <code>parameter</code> =&gt; <code>value</code></li></ul><p>Output:</p><ul><li>new ode with the parameters in param_values plugged with the given numbers</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/a7867a5c159d10ce9b15e2b7336bbafe6b32d3b6/src/ODE.jl#L87-L96">source</a></section></article><h2 id="Create-Compartmental-Model"><a class="docs-heading-anchor" href="#Create-Compartmental-Model">Create Compartmental Model</a><a id="Create-Compartmental-Model-1"></a><a class="docs-heading-anchor-permalink" href="#Create-Compartmental-Model" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.linear_compartment_model" href="#StructuralIdentifiability.linear_compartment_model"><code>StructuralIdentifiability.linear_compartment_model</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">linear_compartment_model(graph, inputs, outputs, leaks)</code></pre><p>Input: defines a linear compartment model with nodes numbered from 1 to <code>n</code> by</p><ul><li><code>graph</code> - and array of integer arrays representing the adjacency lists of the graph</li><li><code>inputs</code> - array of input nodes</li><li><code>outputs</code> - array of output nodes</li><li><code>leaks</code> - array of sink nodes</li></ul><p>Output:</p><ul><li>the corresponding ODE system in the notation of https://doi.org/10.1007/s11538-015-0098-0</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/a7867a5c159d10ce9b15e2b7336bbafe6b32d3b6/src/lincomp.jl#L16-L27">source</a></section></article><h2 id="Discrete-time-systems"><a class="docs-heading-anchor" href="#Discrete-time-systems">Discrete-time systems</a><a id="Discrete-time-systems-1"></a><a class="docs-heading-anchor-permalink" href="#Discrete-time-systems" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.@DDSmodel" href="#StructuralIdentifiability.@DDSmodel"><code>StructuralIdentifiability.@DDSmodel</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">macro DDSmodel</code></pre><p>Macro for creating a DDS (discrete dynamical system)  from a list of equations. It also injects all variables into the global scope.</p><p><strong>Example</strong></p><p>Creating a simple <code>DDS</code>:</p><pre><code class="language-julia hljs">using StructuralIdentifiability
+)</code></pre><p>Here,</p><ul><li><code>x1</code>, <code>x2</code> are state variables</li><li><code>y</code> is an output variable</li><li><code>u</code> is an input variable</li><li><code>a</code>, <code>b</code>, <code>c</code> are time-independent parameters</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/826cd5925661890e0a1cf28211e70151f9bd6fc9/src/input_macro.jl#L242-L268">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.ODE" href="#StructuralIdentifiability.ODE"><code>StructuralIdentifiability.ODE</code></a> — <span class="docstring-category">Type</span></header><section><div><p>The main structure that represents input ODE system.</p><p>Stores information about states (<code>x_vars</code>), outputs (<code>y_vars</code>), inputs (<code>u_vars</code>), parameters (<code>parameters</code>) and the equations.</p><p>This structure is constructed via <code>@ODEmodel</code> macro.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/826cd5925661890e0a1cf28211e70151f9bd6fc9/src/ODE.jl#L1-L7">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.set_parameter_values" href="#StructuralIdentifiability.set_parameter_values"><code>StructuralIdentifiability.set_parameter_values</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set_parameter_values(ode, param_values)</code></pre><p>Input:</p><ul><li><code>ode</code> - an ODE as above</li><li><code>param_values</code> - values for (possibly, some of) the parameters as dictionary <code>parameter</code> =&gt; <code>value</code></li></ul><p>Output:</p><ul><li>new ode with the parameters in param_values plugged with the given numbers</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/826cd5925661890e0a1cf28211e70151f9bd6fc9/src/ODE.jl#L87-L96">source</a></section></article><h2 id="Create-Compartmental-Model"><a class="docs-heading-anchor" href="#Create-Compartmental-Model">Create Compartmental Model</a><a id="Create-Compartmental-Model-1"></a><a class="docs-heading-anchor-permalink" href="#Create-Compartmental-Model" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.linear_compartment_model" href="#StructuralIdentifiability.linear_compartment_model"><code>StructuralIdentifiability.linear_compartment_model</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">linear_compartment_model(graph, inputs, outputs, leaks)</code></pre><p>Input: defines a linear compartment model with nodes numbered from 1 to <code>n</code> by</p><ul><li><code>graph</code> - and array of integer arrays representing the adjacency lists of the graph</li><li><code>inputs</code> - array of input nodes</li><li><code>outputs</code> - array of output nodes</li><li><code>leaks</code> - array of sink nodes</li></ul><p>Output:</p><ul><li>the corresponding ODE system in the notation of https://doi.org/10.1007/s11538-015-0098-0</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/826cd5925661890e0a1cf28211e70151f9bd6fc9/src/lincomp.jl#L16-L27">source</a></section></article><h2 id="Discrete-time-systems"><a class="docs-heading-anchor" href="#Discrete-time-systems">Discrete-time systems</a><a id="Discrete-time-systems-1"></a><a class="docs-heading-anchor-permalink" href="#Discrete-time-systems" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="StructuralIdentifiability.@DDSmodel" href="#StructuralIdentifiability.@DDSmodel"><code>StructuralIdentifiability.@DDSmodel</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">macro DDSmodel</code></pre><p>Macro for creating a DDS (discrete dynamical system)  from a list of equations. It also injects all variables into the global scope.</p><p><strong>Example</strong></p><p>Creating a simple <code>DDS</code>:</p><pre><code class="language-julia hljs">using StructuralIdentifiability
 
 dds = @DDSmodel(
     x1(t + 1) = a * x1(t) + u(t),
     x2(t + 1) = b * x2(t) + c*x1(t)*x2(t),
     y(t) = x1(t)
-)</code></pre><p>Here,</p><ul><li><code>x1</code>, <code>x2</code> are state variables</li><li><code>y</code> is an output variable</li><li><code>u</code> is an input variable</li><li><code>a</code>, <code>b</code>, <code>c</code> are time-independent parameters</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/a7867a5c159d10ce9b15e2b7336bbafe6b32d3b6/src/input_macro.jl#L275-L302">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/reparametrization/">« Reparametrizations</a><a class="docs-footer-nextpage" href="../../identifiability/identifiability/">Functions to Assess Identifiability »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 19 May 2024 15:07">Sunday 19 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+)</code></pre><p>Here,</p><ul><li><code>x1</code>, <code>x2</code> are state variables</li><li><code>y</code> is an output variable</li><li><code>u</code> is an input variable</li><li><code>a</code>, <code>b</code>, <code>c</code> are time-independent parameters</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/826cd5925661890e0a1cf28211e70151f9bd6fc9/src/input_macro.jl#L275-L302">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorials/reparametrization/">« Reparametrizations</a><a class="docs-footer-nextpage" href="../../identifiability/identifiability/">Functions to Assess Identifiability »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 19 May 2024 15:28">Sunday 19 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>