Installation

There are several ways to install the package. We recommend using anaconda. gcm_toolkit has been tested to work on linux and mac.

Using anaconda

Create an anaconda environment.

conda create -n 'GCM' -y
conda activate GCM

Install a few optional packages

conda install -c conda-forge cubedsphere jupyterlab cartopy -y
pip install git+https://github.com/MITgcm/xmitgcm.git

Note

The cubedsphere package has many dependencies and it is only needed for reading in and converting raw MITgcm files. It might not work in several environments.

Install gcm_toolkit.

pip install gcm-toolkit

Note

If you prefer to install a development version, you can use the following command:

git clone https://github.com/exorad/gcm_toolkit.git
pip install -e gcm_toolkit

We recommend to install pre-commit into your git hooks. This will automatically format the code to meet common style guidelines. Its as easy as:

cd gcm_toolkit
pre-commit install