From a4cd474c826ebf98d9a9dcb95f522c066d56c3cf Mon Sep 17 00:00:00 2001 From: Sam Isaacson Date: Sat, 22 Mar 2025 16:59:18 -0400 Subject: [PATCH] Update README.md with installation instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 7f95a72858..1485220cab 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,21 @@ Generated models can be used with solvers throughout the broader Julia and for sensitivity analysis, parameter estimation, machine learning applications, etc). +## Installation +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. +```julia +using Pkg + +# (optional but recommended) create new environment in which to install Catalyst +Pkg.activate("catalyst_environment") + +# install ModelingToolkit 9.59 +Pkg.add(; name = "ModelingToolkit", version ="9.59") + +# install latest Catalyst release +Pkg.add("Catalyst") +``` + ## Breaking changes and new features **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.