Skip to content

Commit 733f50b

Browse files
authored
Merge pull request #1242 from isaacsas/update_docs_post_v15
Some doc update post v15
2 parents 91cf639 + 633152b commit 733f50b

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

docs/src/introduction_to_catalyst/introduction_to_catalyst.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,9 +165,6 @@ nothing # hide
165165
`oprob` and `oprob2` are functionally equivalent, each representing the same
166166
underlying problem.
167167

168-
!!! note
169-
Above we have used `odesys = complete(odesys)` to mark the `ODESystem` as *complete*, indicating to Catalyst and ModelingToolkit that these models are finalized. This must be done before any system is given as input to a `convert` call or some problem type. `ReactionSystem` models created through the `@reaction_network` DSL, like `rn` above, are always marked as complete when generated. Hence `complete` does not need to be called on them. Symbolically generated `ReactionSystem`s, `ReactionSystem`s generated via the `@network_component` macro, and any ModelingToolkit system generated by `convert` always needs to be manually marked as `complete` as we do for `odesys` above. An expanded description on *completeness* can be found [here](@ref completeness_note).
170-
171168
At this point we are all set to solve the ODEs. We can now use any ODE solver
172169
from within the
173170
[OrdinaryDiffEq.jl](https://docs.sciml.ai/DiffEqDocs/stable/solvers/ode_solve/)
@@ -182,6 +179,9 @@ We see the well-known oscillatory behavior of the repressilator! For more on the
182179
choices of ODE solvers, see the [OrdinaryDiffEq.jl
183180
documentation](https://docs.sciml.ai/DiffEqDocs/stable/solvers/ode_solve/).
184181

182+
!!! note
183+
In the above example we used `odesys = complete(odesys)` to mark the `ODESystem` as *complete*, indicating to Catalyst and ModelingToolkit that these models are finalized. This must be done before any system is given as input to a `convert` call or some problem type. `ReactionSystem` models created through the `@reaction_network` DSL, like `rn` above, are always marked as complete when generated. Hence `complete` does not need to be called on them. Symbolically generated `ReactionSystem`s, `ReactionSystem`s generated via the `@network_component` macro, and any ModelingToolkit system generated by `convert` always needs to be manually marked as `complete` as we do for `odesys` above. An expanded description on *completeness* can be found [here](@ref completeness_note).
184+
185185
---
186186

187187
## Stochastic simulation algorithms (SSAs) for stochastic chemical kinetics

docs/src/introduction_to_catalyst/math_models_intro.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,16 @@ while the jump process propensity function is
7272
```math
7373
a(\mathbf{X}(t)) = k A (A-1) B.
7474
```
75+
One can also specify during system construction that by default combinatoric
76+
scalings should be disabled, i.e.
77+
```@example math_examples
78+
using Catalyst
79+
rn = @reaction_network begin
80+
@combinatoric_ratelaws false
81+
k, 3A + 2B --> A + 3D
82+
end
83+
osys = convert(ODESystem, rn)
84+
```
7585

7686
## [Reaction Rate Equation (RRE) ODE Models](@id math_models_in_catalyst_rre_odes)
7787
The RRE ODE models Catalyst creates for a general system correspond to the coupled system of ODEs given by

docs/src/model_creation/programmatic_CRN_construction.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Here we use `nothing` where the DSL used ``\varnothing``. Finally, we are ready
5252
to construct our [`ReactionSystem`](@ref) as
5353
```@example ex
5454
@named repressilator = ReactionSystem(rxs, t)
55+
repressilator = complete(repressilator)
5556
nothing # hide
5657
```
5758
Notice, the model is named `repressilator`. A name must always be specified when
@@ -62,7 +63,7 @@ Alternatively, one can use the `name = :repressilator` keyword argument to the
6263
`ReactionSystem` constructor.
6364

6465
!!! warning
65-
All `ReactionSystem`s created via the symbolic interface (i.e. by calling `ReactionSystem` with some input, rather than using `@reaction_network`) are not marked as complete. To simulate them, they must first be marked as *complete*, indicating to Catalyst and ModelingToolkit that they represent finalized models. 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+
All `ReactionSystem`s created via the symbolic interface (i.e. by calling `ReactionSystem` with some input, rather than using `@reaction_network`) are not marked as complete. To simulate them, they must first be marked as *complete*, indicating to Catalyst and ModelingToolkit that they represent finalized models. This can be done using the `complete` function, as above. An expanded description on *completeness* can be found [here](@ref completeness_note).
6667

6768
We can check that this is the same model as the one we defined via the DSL as
6869
follows (this requires that we use the same names for rates, species and the

0 commit comments

Comments
 (0)