You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/catalyst_functionality/compositional_modeling.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ can construct the earlier repressilator model by composing together three
5
5
identically repressed genes, and how to use compositional modeling to create
6
6
compartments.
7
7
8
-
## A note on *completeness*
8
+
## [A note on *completeness*](@id completeness_note)
9
9
Catalyst `ReactionSystem` can either be *complete* or *incomplete*. When created using the `@reaction_network` DSL they are *created as complete*. Here, only complete `ReactionSystem`s can be used to create the various problem types (e.g. `ODEProblem`). However, only incomplete `ReactionSystem`s can be composed using the features described below. Hence, for compositional modeling, `ReactionSystem` must be created as incomplete, and later set to complete before simulation.
10
10
11
11
To create incomplete `ReactionSystem`s using the DSL as complete, use the `@network_component` instead of `@reaction_network`:
@@ -15,13 +15,13 @@ degradation_component = @network_component begin
15
15
d, X --> 0
16
16
end
17
17
```
18
-
Or when created directly, use the `complete = false` argument:
18
+
Alternatively all `ReactionSystem`s created programmatically are incomplete:
Copy file name to clipboardExpand all lines: docs/src/catalyst_functionality/programmatic_CRN_construction.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,6 +61,9 @@ system to be the same as the name of the variable storing the system.
61
61
Alternatively, one can use the `name = :repressilator` keyword argument to the
62
62
`ReactionSystem` constructor.
63
63
64
+
!!! warn
65
+
All `ReactionSystem`s created programmatically (i.e. by calling `ReactionSystem` with some input, rather than using `@reaction_network`) are created as *incomplete*. To simulate them, they must first be made *complete*. This can be done using the `complete` function, i.e. by calling `repressilator = complete(repressilator)`. An expanded description on *completeness* can be found [here](@ref completeness_note).
66
+
64
67
We can check that this is the same model as the one we defined via the DSL as
65
68
follows (this requires that we use the same names for rates, species and the
always be converted to `symbolic` mappings using [`symmap_to_varmap`](@ref),
153
155
see the [Basic Syntax](@ref basic_examples) section for more details.
154
156
157
+
158
+
!!! note
159
+
Above we have used `repressilator = complete(repressilator)` and `odesys = complete(odesys)` to mark these systems as *complete*. This must be done before any system is given as input to a `convert` call or some problem type. Models created through the @reaction_network` DSL (which is introduced elsewhere, and primarily used throughout these documentation) are created as complete. Hence `complete` does not need to be called on these models. An expanded description on *completeness* can be found [here](@ref completeness_note).
160
+
155
161
At this point we are all set to solve the ODEs. We can now use any ODE solver
0 commit comments