Installation#

Requirements#

xgcm is compatible with python 3 (>= version 3.9). It requires xarray (>= version 0.20.0) numpy and dask.

The easiest way to install xgcm along with its dependencies is via conda forge:

conda install -c conda-forge xgcm

An alternative is to use pip:

pip install xgcm

This will install the latest release from pypi.

xgcm is under active development. To obtain the latest development version, you may clone the source repository and install it using pip:

pip install git+https://github.com/xgcm/xgcm.git

More comprehensive instructions for installing a development environment can be found in the [Contributor Guide](https://xgcm.readthedocs.io/en/latest/contributor_guide.html).

Users are encouraged to fork xgcm and submit issues and pull requests.