Installation

For a user of CSET the recommended way to install CSET is via conda. It is packaged on conda-forge in the cset package. The following command will install CSET into its own conda environment, which is recommended to avoid possible package conflicts.

Caution

The example shell snippets in this documentation use bash, and may not work with other shells. In particular there are known issues activating conda environments with ksh.

conda create --name=cset --channel=conda-forge cset

To use CSET, you need to activate the conda environment with the conda activate command.

conda activate cset

Note

You will have to rerun the conda activate cset command whenever you use a new terminal.

Once that is done, CSET should be ready to use. This can be verified by running a simple command.

cset --version

This command should output the installed version of CSET. This will look something like CSET vX.Y.Z.

You now have CSET installed, so try another tutorial.

Note

This page details installing a released version of CSET. If you instead want to run a development version that has yet to be released, see Set-up code and tooling.