Installation

Stable release

To install xclim via pip, run this command in your terminal:

$ pip install xclim

This is the preferred method to install xclim, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

Anaconda release

For ease of installation across operating systems, we also offer an Anaconda Python package hosted on conda-forge. This version tends to be updated at around the same frequency as the pip library, but can lag by a few days at times.

To install the xclim Anaconda binary, run this command in your terminal:

$ conda install -c conda-forge xclim

Extra dependencies

To improve performance of xclim, we highly recommend you also install flox (see: flox API). This package integrates into xarray and significantly improves the performance of the grouping and resampling algorithms, especially when using dask on large datasets.

We also recommend using the subsetting tools in clisops (see: clisops.core.subset API) for spatial manipulation of geospatial data.

xclim is regularly tested against the main development branches of a handful of key base libraries (xarray, cftime, flox, pint). For convenience, these libraries can be installed alongside xclim using the following pip-installable recipe:

$ pip install -r requirements_upstream.txt
# Or, alternatively:
$ make upstream

From sources

Warning

For Python3.10+ users: Many of the required scientific libraries do not currently have wheels that support the latest python. In order to ensure that installation of xclim doesn’t fail, we suggest installing the Cython module before installing xclim in order to compile necessary libraries from source packages.

The sources for xclim can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git@github.com:Ouranosinc/xclim.git

Or download the tarball:

$ curl -OL https://github.com/Ouranosinc/xclim/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Alternatively, you can also install a local development copy via pip:

$ pip install -e .[dev]

Creating a Conda environment

To create a conda development environment including all xclim dependencies, enter the following command from within your cloned repo:

$ conda create -n my_xclim_env python=3.8 --file=environment.yml
$ conda activate my_xclim_env
(my_xclim_env) $ pip install ".[dev]"