Skip to content

Commit a4cd474

Browse files
authored
Update README.md with installation instructions
1 parent 12331ae commit a4cd474

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ Generated models can be used with solvers throughout the broader Julia and
3030
for sensitivity analysis, parameter estimation, machine learning applications,
3131
etc).
3232

33+
## Installation
34+
Catalyst can be installed as follows. Please note, we suggest only installing ModelingToolkit versions 9.59 and earlier for use with Catalyst at this time as changes in ModelingToolkit as of version 9.60 can break various Catalyst functionality.
35+
```julia
36+
using Pkg
37+
38+
# (optional but recommended) create new environment in which to install Catalyst
39+
Pkg.activate("catalyst_environment")
40+
41+
# install ModelingToolkit 9.59
42+
Pkg.add(; name = "ModelingToolkit", version ="9.59")
43+
44+
# install latest Catalyst release
45+
Pkg.add("Catalyst")
46+
```
47+
3348
## Breaking changes and new features
3449

3550
**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.

0 commit comments

Comments
 (0)