Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document installing CSET into its own environment #198

Merged
merged 1 commit into from
Oct 5, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/source/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ Installation
.. Tutorial saying how to install CSET. For edge cases should link elsewhere.

The recommended way to install CSET is via conda. It is packaged on
`conda-forge`_ and can be installed with a simple ``conda install -c conda-forge
cset``.
`conda-forge`_ and can be installed with a simple ``conda create --name=cset
--channel=conda-forge cset``. This will install CSET into its own conda
environment, which is the recommended way to use it, but it is also possible to
install it into an existing environment.

If you instead want to run a development version that has yet to be released,
the easiest way is via an editable install. You can learn how to do this in the
Expand Down