Skip to content

Commit 060efc7

Browse files
Merge pull request #1535 from SciML/stdlib
Give the ModelingToolkit Standard Library some space in the docs
2 parents eb743e2 + 76fb1d8 commit 060efc7

File tree

3 files changed

+27
-1
lines changed

3 files changed

+27
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ For information on using the package,
2020
[in-development documentation](https://mtk.sciml.ai/dev/) for the version of
2121
the documentation which contains the unreleased features.
2222

23+
## Standard Library
24+
25+
For a standard library of ModelingToolkit components and blocks, check out the
26+
[ModelingToolkitStandardLibrary](https://github.com/SciML/ModelingToolkitStandardLibrary.jl)
27+
2328
## High-Level Examples
2429

2530
First, let's define a second order riff on the Lorenz equations, symbolically

docs/src/index.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,12 @@ is built on, consult the
7575
- Chemical Reactions (via [Catalyst.jl](https://github.com/SciML/Catalyst.jl))
7676
- Nonlinear Optimal Control
7777

78+
## Standard Library
79+
80+
For quick development, ModelingToolkit.jl includes
81+
[ModelingToolkitStandardLibrary.jl](https://github.com/SciML/ModelingToolkitStandardLibrary.jl),
82+
a standard library of prebuilt components for the ModelingToolkit ecosystem.
83+
7884
## Model Import Formats
7985

8086
- [CellMLToolkit.jl](https://github.com/SciML/CellMLToolkit.jl): Import [CellML](https://www.cellml.org/) models into ModelingToolkit
@@ -111,12 +117,19 @@ Below is an incomplete list of extension libraries one may want to be aware of:
111117
- Generates ODESystems for the moment closures
112118
- Allows for geometrically-distributed random reaction rates
113119
- [ReactionMechanismSimulator.jl](https://github.com/ReactionMechanismGenerator/ReactionMechanismSimulator.jl):
114-
simulating and analyzing large chemical reaction mechanisms
120+
Simulating and analyzing large chemical reaction mechanisms
115121
- Ideal gas and dilute liquid phases.
116122
- Constant T and P and constant V adiabatic ideal gas reactors.
117123
- Constant T and V dilute liquid reactors.
118124
- Diffusion limited rates. Sensitivity analysis for all reactors.
119125
- Flux diagrams with molecular images (if molecular information is provided).
126+
- [NumCME.jl](https://github.com/voduchuy/NumCME.jl): High-performance simulation of chemical master equations (CME)
127+
- Transient solution of the CME
128+
- Dynamic state spaces
129+
- Accepts reaction systems defined using Catalyst.jl DSL.
130+
- [FiniteStateProjection.jl](https://github.com/kaandocal/FiniteStateProjection.jl): High-performance simulation of
131+
chemical master equations (CME) via finite state projections
132+
- Accepts reaction systems defined using Catalyst.jl DSL.
120133

121134
## Compatible Numerical Solvers
122135

docs/src/tutorials/acausal_components.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ equations are given by the constraints and equalities between different
99
component variables. We then simplify this to an ODE by eliminating the
1010
equalities before solving. Let's see this in action.
1111

12+
!!! note
13+
14+
This tutorial teaches how to build the entire RC circuit from scratch.
15+
However, to simulate electrical components with more ease, check out the
16+
[ModelingToolkitStandardLibrary.jl](https://github.com/SciML/ModelingToolkitStandardLibrary.jl)
17+
which includes a
18+
[tutorial for simulating RC circuits with pre-built components](http://mtkstdlib.sciml.ai/dev/tutorials/rc_circuit/)
19+
1220
## Copy-Paste Example
1321

1422
```julia

0 commit comments

Comments
 (0)