Installation¶

Requirements¶

xbudget is compatible with python 3 (>= version 3.11). It requires xgcm (>= version 0.10.0).

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

conda install -c conda-forge xbudget

An alternative is to use pip:

pip install xbudget

This will install the latest release from PyPI.

xbudget 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/hdrake/xbudget.git

More comprehensive instructions for setting up a development environment are in the Contributor Guide.

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