Skip to content

Commit edb694f

Browse files
Merge pull request #835 from SciML/docs
Add acausal modeling tutorial
2 parents 90540bb + ab764c8 commit edb694f

File tree

5 files changed

+451
-22
lines changed

5 files changed

+451
-22
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ makedocs(
1212
"Home" => "index.md",
1313
"Tutorials" => Any[
1414
"tutorials/ode_modeling.md",
15+
"tutorials/acausal_components.md",
1516
"tutorials/higher_order.md",
1617
"tutorials/nonlinear.md",
1718
"tutorials/modelingtoolkitize.md",

docs/src/basics/Composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Composing Models and Building Reusable Components](@ref components)
1+
# [Composing Models and Building Reusable Components](@id components)
22

33
The symbolic models of ModelingToolkit can be composed together to
44
easily build large models. The composition is lazy and only instantiated

docs/src/index.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,28 @@ is built on, consult the
6060
- Chemical Reactions
6161
- Optimal Control
6262

63+
## Model Import Formats
64+
65+
- [CellMLToolkit.jl](https://github.com/SciML/CellMLToolkit.jl): Import [CellML](https://www.cellml.org/) models into ModelingToolkit
66+
- Repository of more than a thousand pre-made models
67+
- Focus on biomedical models in areas such as: Calcium Dynamics,
68+
Cardiovascular Circulation, Cell Cycle, Cell Migration, Circadian Rhythms,
69+
Electrophysiology, Endocrine, Excitation-Contraction Coupling, Gene Regulation,
70+
Hepatology, Immunology, Ion Transport, Mechanical Constitutive Laws,
71+
Metabolism, Myofilament Mechanics, Neurobiology, pH Regulation, PKPD,
72+
Protein Modules, Signal Transduction, and Synthetic Biology.
73+
- [SbmlInterface.jl](https://github.com/paulflang/SbmlInterface.jl): Import [SBML](http://sbml.org/Main_Page) models into ModelingToolkit
74+
- Uses the robust libsbml library for parsing and transforming the SBML
75+
- [ReactionNetworkImporters.jl](https://github.com/isaacsas/ReactionNetworkImporters.jl): Import various models into ModelingToolkit
76+
- Supports the BioNetGen `.net` file
77+
- Supports importing networks specified by stoichiometric matrices
78+
6379
## Extension Libraries
6480

6581
Because ModelingToolkit.jl is the core foundation of a equation-based modeling
6682
ecosystem, there is a large set of libraries adding features to this system.
6783
Below is an incomplete list of extension libraries one may want to be aware of:
6884

69-
- [StructuralTransformations.jl](https://github.com/JuliaComputing/StructuralTransformations.jl): Various transformations of models into structurally better versions for improved numerical simulation
70-
- Pantelides algortihm for index reduction of DAEs
71-
- Tearing of `ODESystem`s and `NonolinearSystem`s to reduce the numerical
72-
cost of handling large implicit systems via Newton methods
7385
- [Catalyst.jl](https://github.com/SciML/Catalyst.jl): Symbolic representations of chemical reactions
7486
- Symbolically build and represent large systems of chemical reactions
7587
- Generate code for ODEs, SDEs, continuous-time Markov Chains, and more
@@ -87,22 +99,6 @@ Below is an incomplete list of extension libraries one may want to be aware of:
8799
- Diffusion limited rates. Sensitivity analysis for all reactors.
88100
- Flux diagrams with molecular images (if molecular information is provided).
89101

90-
## Model Import Formats
91-
92-
- [CellMLToolkit.jl](https://github.com/SciML/CellMLToolkit.jl): Import [CellML](https://www.cellml.org/) models into ModelingToolkit
93-
- Repository of more than a thousand pre-made models
94-
- Focus on biomedical models in areas such as: Calcium Dynamics,
95-
Cardiovascular Circulation, Cell Cycle, Cell Migration, Circadian Rhythms,
96-
Electrophysiology, Endocrine, Excitation-Contraction Coupling, Gene Regulation,
97-
Hepatology, Immunology, Ion Transport, Mechanical Constitutive Laws,
98-
Metabolism, Myofilament Mechanics, Neurobiology, pH Regulation, PKPD,
99-
Protein Modules, Signal Transduction, and Synthetic Biology.
100-
- [SbmlInterface.jl](https://github.com/paulflang/SbmlInterface.jl): Import [SBML](http://sbml.org/Main_Page) models into ModelingToolkit
101-
- Uses the robust libsbml library for parsing and transforming the SBML
102-
- [ReactionNetworkImporters.jl](https://github.com/isaacsas/ReactionNetworkImporters.jl): Import various models into ModelingToolkit
103-
- Supports the BioNetGen `.net` file
104-
- Supports importing networks specified by stoichiometric matrices
105-
106102
## Compatible Numerical Solvers
107103

108104
All of the symbolic systems have a direct conversion to a numerical system which

0 commit comments

Comments
 (0)