Skip to content

Commit 7228fd3

Browse files
committed
add more detail on creating environments
1 parent 0a6b9a3 commit 7228fd3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/src/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,23 @@ Pkg.add("Plots")
9797
```
9898
is also needed.
9999

100+
It is **strongly** recommended to run Catalyst in its own environment with the
101+
minimal set of needed packages. For example, to install Catalyst and Plots in a
102+
new environment named `catalyst_project` (saved in the current directory) one
103+
can say
104+
```julia
105+
Pkg.activate("catalyst_project")
106+
Pkg.add("Catalyst")
107+
Pkg.add("Plots")
108+
```
109+
If one would rather just create a temporary environment that is not saved when
110+
exiting Julia you can say
111+
```julia
112+
Pkg.activate(; temp = true)
113+
Pkg.add("Catalyst")
114+
Pkg.add("Plots")
115+
```
116+
100117
A more thorough guide for setting up Catalyst and installing Julia packages can be found [here](@ref catalyst_for_new_julia_users_packages).
101118

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

0 commit comments

Comments
 (0)