Skip to content

Commit

Permalink
value types
Browse files Browse the repository at this point in the history
  • Loading branch information
dweindl committed Dec 10, 2024
1 parent 3769eac commit b79293f
Showing 1 changed file with 34 additions and 4 deletions.
38 changes: 34 additions & 4 deletions doc/v2/documentation_data_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,18 @@ problem as such.

- All model entities, column names and row names are case-sensitive
- Fields in "[]" are optional and may be left empty.
- The following data types are used in descriptions below:

- ``STRING``: Any string
- ``NUMERIC``: Any number excluding ``NaN`` / ``inf`` / ``-inf``
- ``MATH_EXPRESSION``: A mathematical expression according to the
`PEtab math expression syntax <math_expressions>`_.
- ``PETAB_ID``: A string that is a valid PEtab ID
- ``NON_ESTIMATED_ENTITY_ID``: A string that is a valid PEtab ID and refers
to an entity that has some associated numeric value and is not estimated,
e.g., a model parameter, parameter table parameter, or a species in the
model.



Changes from PEtab 1.0.0
Expand Down Expand Up @@ -193,12 +205,30 @@ Detailed field description
The entity must be static in time while the condition is active,
e.g., a model parameter.

- ``initial``: The target is initialized to the value of ``targetValue``.
- ``initial``: The target is initialized to the value of ``targetValue``
when the respective condition is applied. The entity must be dynamic and
defined in terms of time-derivative information, e.g., a non-constant
model species involved in some reaction or specified by an ordinary
differential equation.

- ``rate``: The time-derivative of the target is set to ``targetValue``
(symbolically, not evaluated the time the condition is applied).
The entity must be dynamic and defined in terms of
time-derivative information, e.g., a non-constant model species involved in
some reaction or specified by an ordinary differential equation.

- ``assignment``: The target is set to the value of ``targetValue``, where
the value is evaluated at the time the condition is applied. The entity
must be dynamic, but not defined in terms of time-derivative information.

- ``addToRate``: The target's rate is increased by ``targetValue``.
The entity must be dynamic and defined in terms of time-derivative
information, e.g., a model species involved in some reaction or specified
by an ordinary differential equation.
information.

- ``rate``/``assignment``/``relativeRate``/``relativeAssignment``:
- ``addToAssignment``: The expression assigned to the target is increased by
``targetValue``.
The entity must be dynamic, but not defined in terms of time-derivative
information.

**TODO**

Expand Down

0 comments on commit b79293f

Please sign in to comment.