Metadata-Version: 2.4
Name: xwmt
Version: 0.2.0
Summary: Water Mass Transformation Routines for xarray
Project-URL: Homepage, https://github.com/NOAA-GFDL/xwmt
Project-URL: Bugs/Issues/Features, https://github.com/NOAA-GFDL/xwmt/issues
Project-URL: Related package, https://github.com/hdrake/xwmb
Author-email: "Henri F. Drake" <hfdrake@uci.edu>, Jan-Erik Tesdal <jt7058@princeton.edu>
License-File: LICENSE
Keywords: ocean modeling,oceanography,water mass transformation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Requires-Dist: bottleneck
Requires-Dist: gsw
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: xbudget>=0.6.0
Requires-Dist: xgcm>=0.9.0
Requires-Dist: xhistogram
Description-Content-Type: text/markdown

# xwmt

**xWMT** is a Python package that provides a framework for calculating water mass tranformations in an xarray-based environment.

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

**Minimal installation within an existing environment**
```bash
conda install -c conda-forge xwmt
```

**Installing from scratch using `conda`**

This is the recommended mode of installation for developers.
```bash
git clone git@github.com:NOAA-GFDL/xwmt.git
cd xwmt
conda env create -f docs/environment.yml
conda activate docs_env_xwmt
pip install -e .
```

You can verify that the package was properly installed by confirming it passes all of the tests with:
```bash
pytest -v
```

You can launch a Jupyterlab instance using this environment with:
```bash
python -m ipykernel install --user --name docs_env_xwmt --display-name "docs_env_xwmt"
jupyter-lab
```

