Metadata-Version: 2.4
Name: regionate
Version: 0.5.4
Summary: A package for creating xgcm-grid consistent regional masks and boundaries
Project-URL: Homepage, https://github.com/hdrake/regionate
Project-URL: Bugs/Issues/Features, https://github.com/hdrake/regionate/issues
Project-URL: Sibling package, https://github.com/MOM6-community/sectionate
Author-email: "Henri F. Drake" <hfdrake@uci.edu>
License-File: LICENSE
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: contourpy
Requires-Dist: geopandas
Requires-Dist: proj
Requires-Dist: pyproj
Requires-Dist: regionmask
Requires-Dist: sectionate>=0.3.3
Description-Content-Type: text/markdown

# regionate

A package for creating xgcm-grid consistent regional masks and boundaries, leveraging its sibling package [`sectionate`](https://github.com/raphaeldussin/sectionate).

Quick Start Guide
-----------------

**For users: minimal installation within an existing environment**
```bash
pip install regionate
```

**For developers: installing from scratch using `conda`**
```bash
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
```
