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

Installation from Conda Forge#

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

conda install -c conda-forge xgcm

Installation from Pip#

An alternative is to use pip:

pip install xgcm

This will install the latest release from pypi.

Installation from GitHub#

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

git clone
cd xgcm
python install

or simply:

pip install git+

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