README.md

regionate

A package for creating xgcm-grid consistent regional masks and boundaries, leveraging its sibling package sectionate.

Quick Start Guide

For users: minimal installation within an existing environment

conda install -c conda-forge regionate

For developers: installing from scratch using conda

git clone git@github.com:hdrake/regionate.git
cd regionate
conda env create -f docs/environment.yml
conda activate docs_env_regionate
pip install -e .
python -m ipykernel install --user --name docs_env_regionate --display-name "docs_env_regionate"
jupyter-lab