Skip to content

Commit 5b1a8d6

Browse files
author
Documenter.jl
committed
build based on edba396
1 parent 969475e commit 5b1a8d6

File tree

19 files changed

+25
-25
lines changed

19 files changed

+25
-25
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.12.3","generation_timestamp":"2026-01-04T17:43:45","documenter_version":"1.16.1"}}
1+
{"documenter":{"julia_version":"1.12.3","generation_timestamp":"2026-01-05T22:22:22","documenter_version":"1.16.1"}}

dev/export/export/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/identifiability/identifiability/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

dev/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
Official https://julialang.org release
2424
Platform Info:
2525
OS: Linux (x86_64-linux-gnu)
26-
CPU: 4 × AMD EPYC 7763 64-Core Processor
26+
CPU: 4 × Intel(R) Xeon(R) Platinum 8370C CPU @ 2.80GHz
2727
WORD_SIZE: 64
28-
LLVM: libLLVM-18.1.7 (ORCJIT, znver3)
28+
LLVM: libLLVM-18.1.7 (ORCJIT, icelake-server)
2929
GC: Built with stock GC
3030
Threads: 1 default, 1 interactive, 1 GC (on 4 virtual cores)</code></pre></details><details><summary>A more complete overview of all dependencies and their versions is also provided.</summary><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Status `~/work/StructuralIdentifiability.jl/StructuralIdentifiability.jl/docs/Manifest.toml`
3131
[47edcb42] ADTypes v1.21.0
@@ -229,4 +229,4 @@
229229
[3f19e933] p7zip_jll v17.7.0+0
230230
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
231231
<a href="">manifest</a> file and the
232-
<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><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.16.1 on <span class="colophon-date" title="Sunday 4 January 2026 17:43">Sunday 4 January 2026</span>. Using Julia version 1.12.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
232+
<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><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.16.1 on <span class="colophon-date" title="Monday 5 January 2026 22:22">Monday 5 January 2026</span>. Using Julia version 1.12.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/input/input/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
x1&#39;(t) = a * x1(t) + u(t),
1010
x2&#39;(t) = b * x2(t) + c*x1(t)*x2(t),
1111
y(t) = x1(t)
12-
)</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/91e2d6c96b0b8ef956c50df65321a41bdf655c90/src/input_macro.jl#L267-L293">source</a></section></details></article><article><details class="docstring" open="true"><summary id="StructuralIdentifiability.ODE"><a class="docstring-binding" href="#StructuralIdentifiability.ODE"><code>StructuralIdentifiability.ODE</code></a><span class="docstring-category">Type</span></summary><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/91e2d6c96b0b8ef956c50df65321a41bdf655c90/src/ODE.jl#L1-L7">source</a></section></details></article><article><details class="docstring" open="true"><summary id="StructuralIdentifiability.set_parameter_values"><a class="docstring-binding" href="#StructuralIdentifiability.set_parameter_values"><code>StructuralIdentifiability.set_parameter_values</code></a><span class="docstring-category">Function</span></summary><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/91e2d6c96b0b8ef956c50df65321a41bdf655c90/src/ODE.jl#L96-L105">source</a></section></details></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><details class="docstring" open="true"><summary id="StructuralIdentifiability.linear_compartment_model"><a class="docstring-binding" href="#StructuralIdentifiability.linear_compartment_model"><code>StructuralIdentifiability.linear_compartment_model</code></a><span class="docstring-category">Function</span></summary><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 a standard notation (as, e.g., in <a href="https://doi.org/10.1007/s11538-015-0098-0">this paper</a>)</li></ul><p>Example: Consider a bidirected cycle with four nodes. Its adjacency list can be written as follows:</p><pre><code class="language-julia hljs">[ [2, 4], [1, 3], [2, 4], [1, 3] ]</code></pre><p>In the list above, the <code>i</code>-th element is a list of vertices to which there exists an edge from the vertex <code>i</code>. Now we can create a linear compartment model over this graph with the output at vertex 1, input at vertex 2, and leaks at vertices 3 and 4 as follows:</p><pre><code class="language-julia-repl hljs">julia&gt; ode = linear_compartment_model([[2, 4], [1, 3], [2, 4], [1, 3]], outputs = [1], inputs = [2], leaks = [2, 3])
12+
)</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/edba3965dc1b31b615bb68823f20e6a3fa463a2d/src/input_macro.jl#L267-L293">source</a></section></details></article><article><details class="docstring" open="true"><summary id="StructuralIdentifiability.ODE"><a class="docstring-binding" href="#StructuralIdentifiability.ODE"><code>StructuralIdentifiability.ODE</code></a><span class="docstring-category">Type</span></summary><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/edba3965dc1b31b615bb68823f20e6a3fa463a2d/src/ODE.jl#L1-L7">source</a></section></details></article><article><details class="docstring" open="true"><summary id="StructuralIdentifiability.set_parameter_values"><a class="docstring-binding" href="#StructuralIdentifiability.set_parameter_values"><code>StructuralIdentifiability.set_parameter_values</code></a><span class="docstring-category">Function</span></summary><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/edba3965dc1b31b615bb68823f20e6a3fa463a2d/src/ODE.jl#L96-L105">source</a></section></details></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><details class="docstring" open="true"><summary id="StructuralIdentifiability.linear_compartment_model"><a class="docstring-binding" href="#StructuralIdentifiability.linear_compartment_model"><code>StructuralIdentifiability.linear_compartment_model</code></a><span class="docstring-category">Function</span></summary><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 a standard notation (as, e.g., in <a href="https://doi.org/10.1007/s11538-015-0098-0">this paper</a>)</li></ul><p>Example: Consider a bidirected cycle with four nodes. Its adjacency list can be written as follows:</p><pre><code class="language-julia hljs">[ [2, 4], [1, 3], [2, 4], [1, 3] ]</code></pre><p>In the list above, the <code>i</code>-th element is a list of vertices to which there exists an edge from the vertex <code>i</code>. Now we can create a linear compartment model over this graph with the output at vertex 1, input at vertex 2, and leaks at vertices 3 and 4 as follows:</p><pre><code class="language-julia-repl hljs">julia&gt; ode = linear_compartment_model([[2, 4], [1, 3], [2, 4], [1, 3]], outputs = [1], inputs = [2], leaks = [2, 3])
1313
x1&#39; = -x1*a_2_1 - x1*a_4_1 + x2*a_1_2 + x4*a_1_4
1414
x3&#39; = x2*a_3_2 - x3*a_2_3 - x3*a_4_3 - x3*a_0_3 + x4*a_3_4
1515
x2&#39; = x1*a_2_1 - x2*a_1_2 - x2*a_3_2 - x2*a_0_2 + x3*a_2_3 + u2
1616
x4&#39; = x1*a_4_1 + x3*a_4_3 - x4*a_1_4 - x4*a_3_4
17-
y1 = x1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/91e2d6c96b0b8ef956c50df65321a41bdf655c90/src/lincomp.jl#L16-L43">source</a></section></details></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><details class="docstring" open="true"><summary id="StructuralIdentifiability.@DDSmodel"><a class="docstring-binding" href="#StructuralIdentifiability.@DDSmodel"><code>StructuralIdentifiability.@DDSmodel</code></a><span class="docstring-category">Macro</span></summary><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
17+
y1 = x1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/StructuralIdentifiability.jl/blob/edba3965dc1b31b615bb68823f20e6a3fa463a2d/src/lincomp.jl#L16-L43">source</a></section></details></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><details class="docstring" open="true"><summary id="StructuralIdentifiability.@DDSmodel"><a class="docstring-binding" href="#StructuralIdentifiability.@DDSmodel"><code>StructuralIdentifiability.@DDSmodel</code></a><span class="docstring-category">Macro</span></summary><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
1818

1919
dds = @DDSmodel(
2020
x1(t + 1) = a * x1(t) + u(t),
2121
x2(t + 1) = b * x2(t) + c*x1(t)*x2(t),
2222
y(t) = x1(t)
23-
)</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/91e2d6c96b0b8ef956c50df65321a41bdf655c90/src/input_macro.jl#L300-L327">source</a></section></details></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><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.16.1 on <span class="colophon-date" title="Sunday 4 January 2026 17:43">Sunday 4 January 2026</span>. Using Julia version 1.12.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
23+
)</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/edba3965dc1b31b615bb68823f20e6a3fa463a2d/src/input_macro.jl#L300-L327">source</a></section></details></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><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.16.1 on <span class="colophon-date" title="Monday 5 January 2026 22:22">Monday 5 January 2026</span>. Using Julia version 1.12.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)