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: README.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,9 +32,11 @@ etc).
32
32
33
33
## Breaking changes and new features
34
34
35
-
**NOTE:** Version 14 is a breaking release, prompted by the release of ModelingToolkit.jl version 9. This caused several breaking changes in how Catalyst models are represented and interfaced with.
35
+
**NOTE:** Version 14 is a breaking release, prompted by the release of ModelingToolkit.jl version 9.
36
+
This caused several breaking changes in how Catalyst models are represented and interfaced with.
36
37
37
-
Breaking changes and new functionality are summarized in the [HISTORY.md](HISTORY.md) file. This also includes a special migration guide for version 14.
38
+
Breaking changes and new functionality are summarized in the [HISTORY.md](HISTORY.md) file.
39
+
This also includes a special migration guide for version 14.
38
40
39
41
## Tutorials and documentation
40
42
@@ -43,7 +45,8 @@ documentation](https://docs.sciml.ai/Catalyst/stable/). The [in-development
43
45
documentation](https://docs.sciml.ai/Catalyst/dev/) describes unreleased features in
44
46
the current master branch.
45
47
46
-
An overview of the package, its features, and comparative benchmarking (as of version 13) can also be found in its corresponding research paper, [Catalyst: Fast and flexible modeling of reaction networks](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1011530).
48
+
An overview of the package, its features, and comparative benchmarking (as of version 13) can also
49
+
be found in its corresponding research paper, [Catalyst: Fast and flexible modeling of reaction networks](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1011530).
47
50
48
51
## Features
49
52
@@ -60,13 +63,13 @@ An overview of the package, its features, and comparative benchmarking (as of ve
-[Latexify](https://korsbo.github.io/Latexify.jl/stable/) can be used to [generate LaTeX
96
99
expressions](@ref ref) corresponding to generated mathematical models or the
97
100
underlying set of reactions.
98
101
-[Graphviz](https://graphviz.org/) can be used to generate and [visualize reaction network graphs](@ref ref)
99
102
(reusing the Graphviz interface created in [Catlab.jl](https://algebraicjulia.github.io/Catlab.jl/stable/).)
100
-
-Models steady states can be computed through homotopy continuation using [HomotopyContinuation.jl](https://github.com/JuliaHomotopyContinuation/HomotopyContinuation.jl)
103
+
-Model steady states can be computed through homotopy continuation using [HomotopyContinuation.jl](https://github.com/JuliaHomotopyContinuation/HomotopyContinuation.jl)
101
104
(which can find *all* steady states of systems with multiple ones), by forward ODE simulations using
102
105
[SteadyStateDiffEq.jl)](https://github.com/SciML/SteadyStateDiffEq.jl), or by nonlinear systems
103
106
solving using [NonlinearSolve.jl](https://github.com/SciML/NonlinearSolve.jl).
@@ -110,7 +113,7 @@ An overview of the package, its features, and comparative benchmarking (as of ve
and [PEtab.jl](https://github.com/sebapersson/PEtab.jl) can all be used to [fit model parameters to data](@ref ref).
112
115
-[GlobalSensitivity.jl](https://github.com/SciML/GlobalSensitivity.jl) can be used to perform
113
-
[global sensitivity analysis](@ref ref) of model behaviours.
116
+
[global sensitivity analysis](@ref ref) of model behaviors.
114
117
115
118
#### Features of packages built upon Catalyst
116
119
- Catalyst [`ReactionSystem`](@ref)s can be [imported from SBML files](@ref ref) via
@@ -177,7 +180,13 @@ plot(jump_sol; lw = 2)
177
180
178
181
179
182
## Elaborate example
180
-
In the above example, we used basic Catalyst-based workflows to simulate a simple model. Here we instead show how various Catalyst features can compose to create a much more advanced model. Our model describes how the volume of a cell ($V$) is affected by a growth factor ($G$). The growth factor only promotes growth while in its phosphorylated form ($Gᴾ$). The phosphorylation of $G$ ($G \to Gᴾ$) is promoted by sunlight (modelled as the cyclic sinusoid $kₐ*(sin(t)+1)$) phosphorylates the growth factor (producing $Gᴾ$). When the cell reaches a critical volume ($V$) it goes through cell division. First, we declare our model:
183
+
In the above example, we used basic Catalyst-based workflows to simulate a simple model. Here we
184
+
instead show how various Catalyst features can compose to create a much more advanced model. Our
185
+
model describes how the volume of a cell ($V$) is affected by a growth factor ($G$). The growth
186
+
factor only promotes growth while in its phosphorylated form ($Gᴾ$). The phosphorylation of $G$
187
+
($G \to Gᴾ$) is promoted by sunlight (modelld as the cyclic sinusoid $kₐ*(sin(t)+1)$), which
188
+
phosphorylates the growth factor (producing $Gᴾ$). When the cell reaches a critical volume ($V$)
189
+
it undergoes through cell division. First, we declare our model:
181
190
```julia
182
191
using Catalyst
183
192
cell_model =@reaction_networkbegin
@@ -193,7 +202,8 @@ cell_model = @reaction_network begin
193
202
kᵢ/V, Gᴾ --> G
194
203
end
195
204
```
196
-
Next, we can use [Latexify.jl](https://korsbo.github.io/Latexify.jl/stable/) to show the ordinary differential equations associated with this model:
205
+
Next, we can use [Latexify.jl](https://korsbo.github.io/Latexify.jl/stable/) to show the ordinary
206
+
differential equations associated with this model:
0 commit comments