Metadata-Version: 2.4
Name: xbudget
Version: 0.6.1
Summary: Helper functions and meta-data conventions for wrangling finite-volume ocean model budgets
Project-URL: Homepage, https://github.com/hdrake/xbudget
Project-URL: Bugs/Issues/Features, https://github.com/hdrake/xbudget/issues
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: numpy
Requires-Dist: xarray
Requires-Dist: xgcm>=0.9.0
Description-Content-Type: text/markdown

# xbudget
Helper functions and meta-data conventions for wrangling finite-volume ocean model budgets.

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

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

**For developers: installing from scratch using `conda`**
```bash
git clone git@github.com:hdrake/xbudget.git
cd xbudget
conda env create -f docs/environment.yml
conda activate docs_env_xbudget
pip install -e .
python -m ipykernel install --user --name docs_env_xbudget --display-name "docs_env_xbudget"
jupyter-lab
```
