Installation
Contents
Installation#
Requirements#
GCM-Filters is compatible with python 3. It requires xarray, numpy, and dask.
Installation from conda forge#
GCM-Filters can be installed via conda forge:
conda install -c conda-forge gcm_filters
Installation from pip#
GCM-Filters can also be installed with pip:
pip install gcm_filters
This will install the latest release from pypi.
Installation from GitHub#
GCM-Filters is under active development. To obtain the latest development version, you may clone the source repository and install it:
git clone https://github.com/ocean-eddy-cpt/gcm-filters.git
cd gcm-filters
python setup.py install
or simply:
pip install git+https://github.com/ocean-eddy-cpt/gcm-filters.git
Users are encouraged to fork GCM-Filters and submit issues and pull requests.
How to run the example notebooks#
If you want to run the example notebooks in this documentation, you will need a few extra dependencies that you can install via:
conda env create -f docs/environment.yml
conda activate gcm-filters-docs