Skip to content

Commit 404fb55

Browse files
authored
doc: Clarify equilibration and steady state (#2865)
Try to clarify what we mean by "equilibration", "steady state", ...
1 parent 2e3fecf commit 404fb55

File tree

2 files changed

+59
-11
lines changed

2 files changed

+59
-11
lines changed

doc/about.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ Features
3939
* adjoint
4040
* first- and second-order (second-order Matlab-only)
4141

42-
* Pre-equilibration and pre-simulation conditions
42+
* :term:`Pre-equilibration <pre-equilibration>` and :term:`pre-simulation`
43+
conditions
4344
* Support for
4445
`discrete events and logical operations <https://academic.oup.com/bioinformatics/article/33/7/1049/2769435>`_
4546

@@ -99,11 +100,11 @@ as shown in the following table:
99100
- yes
100101
- yes
101102
- yes
102-
* - :term:`preequilibration`
103+
* - :term:`pre-equilibration`
103104
- yes
104105
- yes
105106
- yes
106-
* - :term:`presimulation`
107+
* - :term:`pre-simulation`
107108
- yes
108109
- yes
109110
- no

doc/glossary.rst

Lines changed: 55 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,19 @@ Glossary
1818
DAE
1919
Differential-Algebraic Equation
2020

21+
equilibration
22+
In AMICI, equilibration refers to the process of simulating or
23+
solving a dynamical system for :term:`steady state`.
24+
"Equilibration" refers to approaching an
25+
`equilibrium point <https://en.wikipedia.org/wiki/Equilibrium_point_(mathematics)>`__
26+
of a dynamical system and does not imply thermodynamic equilibrium.
27+
2128
fixed parameters
2229
In AMICI, *fixed parameters* are parameters with respect to which no
2330
sensitivities are computed. They usually correspond to experimental
2431
conditions. For fixed parameters, different values can be set for
25-
:term:`preequilibration`, :term:`presimulation` and simulation.
32+
:term:`pre-equilibration`, :term:`pre-simulation` and the main
33+
simulation. See also :term:`simulation periods`.
2634

2735
IDAS
2836
`IDAS <https://computing.llnl.gov/projects/sundials/idas>`_ is a
@@ -32,19 +40,31 @@ Glossary
3240
ODE
3341
Ordinary Differential Equation
3442

35-
preequilibration
36-
Simulating or solving the dynamical system for the steadystate.
37-
38-
presimulation
39-
Simulation for a fixed time before the regular simulation. Can be used
40-
to specify pretreatments.
41-
4243
PEtab
4344
`PEtab <https://github.com/PEtab-dev/PEtab>`_ is a format for
4445
specifying parameter estimation problems. It is based on an
4546
:term:`SBML` model and tab-separated value files specifying the
4647
observation model and experimental conditions.
4748

49+
post-equilibration
50+
:term:`equilibration` after the main simulation.
51+
See also :term:`simulation periods`.
52+
53+
pre-equilibration
54+
:term:`Equilibration <equilibration>` before the :term:`pre-simulation`
55+
or main simulation. Pre-equilibration is useful if the system is
56+
assumed to be at steady state at the start of some experiment, but the
57+
initial state is not known.
58+
The model time is reset to its initial time after pre-equilibration.
59+
See also :term:`simulation periods`.
60+
61+
pre-simulation
62+
Simulation for a fixed time before the regular simulation. Can be used
63+
to specify pretreatments. Pre-simulation starts at
64+
:math:`t_0 - t_{presim}`. Dedicated fixed parameters can be
65+
specified for pre-simulation.
66+
See also :term:`simulation periods`.
67+
4868
PySB
4969
`PySB <http://pysb.org/>`_ is a tool for specifying rule-based systems
5070
biology models as Python code.
@@ -53,6 +73,33 @@ Glossary
5373
The `Systems Biology Markup Language <http://sbml.org/>`_ is a
5474
commonly used format for specifying systems biology models.
5575

76+
simulation periods
77+
In AMICI a model simulation may consist of multiple periods:
78+
79+
* A :term:`pre-equilibration` period, which is used to simulate the
80+
system until it reaches :term:`steady state`.
81+
* A :term:`pre-simulation` period, which is used to simulate the system
82+
for a fixed time before the main simulation.
83+
* The main simulation period.
84+
* A :term:`post-equilibration` period, to simulate the system until it
85+
reaches :term:`steady state`.
86+
87+
The main simulation and post-equilibration periods are the only
88+
periods for which output timepoints can be specified and during which
89+
measurements are assumed to be taken.
90+
91+
(Non-fixed) model parameters (:math:`p`) are the same throughout those
92+
periods, but different sets of :term:`fixed parameters` (:math:`k`) can
93+
be specified for each period, except for post-equilibration, which
94+
always uses the fixed parameters of the main simulation period.
95+
96+
steady state
97+
In AMICI, a model is considered to be at steady state if the time
98+
derivative of the state variables is zero, up to the specified
99+
tolerances, even if there are discontinuities in the model
100+
(e.g., due to events) that may change the model state at a later time
101+
point.
102+
56103
SUNDIALS
57104
`SUNDIALS <https://computing.llnl.gov/projects/sundials/>`_:
58105
SUite of Nonlinear and DIfferential/ALgebraic equation Solvers.

0 commit comments

Comments
 (0)