Skip to content

Commit ab266f9

Browse files
authored
Merge pull request #1228 from SciML/isaacsas-installation-instructions
Update installation instructions
2 parents 59140cf + b48a372 commit ab266f9

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/src/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Pkg.add("Plots")
9797
```
9898
is also needed.
9999

100-
It is **strongly** recommended to run Catalyst in its own environment with the
100+
It is **strongly** recommended to install and use Catalyst in its own environment with the
101101
minimal set of needed packages. For example, to install Catalyst and Plots in a
102102
new environment named `catalyst_project` (saved in the current directory) one
103103
can say
@@ -114,6 +114,17 @@ Pkg.add("Catalyst")
114114
Pkg.add("Plots")
115115
```
116116

117+
After installation, we suggest running
118+
```julia
119+
Pkg.status("Catalyst")
120+
```
121+
to confirm that the latest version of Catalyst was installed (and not an older version).
122+
If you have installed into a new environment this should always be the case. However, if you
123+
installed into an existing environment, such as the default Julia global environment, the presence
124+
of incompatible versions of other pre-installed packages could lead to older versions of Catalyst
125+
being installed. In this case we again recommend creating a new environment and installing Catalyst
126+
there to obtain the latest version.
127+
117128
A more thorough guide for setting up Catalyst and installing Julia packages can be found [here](@ref catalyst_for_new_julia_users_packages).
118129

119130
## [Illustrative example](@id doc_index_example)

0 commit comments

Comments
 (0)