Metadata-Version: 2.4
Name: hhemt
Version: 0.1.0
Summary: Tools for running and processing TRITON-SWMM models.
Author-email: Daniel Lassiter <daniel.lassiter@outlook.com>
Maintainer-email: Daniel Lassiter <daniel.lassiter@outlook.com>
License-Expression: PolyForm-Noncommercial-1.0.0
Project-URL: bugs, https://github.com/lassiterdc/hhemt/issues
Project-URL: changelog, https://github.com/lassiterdc/hhemt/blob/main/changelog.md
Project-URL: homepage, https://github.com/lassiterdc/hhemt
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering :: Hydrology
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: filelock
Requires-Dist: pydantic==2.7.*
Requires-Dist: pyyaml
Requires-Dist: zarr
Requires-Dist: netcdf4
Requires-Dist: h5netcdf
Requires-Dist: h5py
Requires-Dist: scipy
Requires-Dist: dask
Requires-Dist: matplotlib
Requires-Dist: seaborn
Requires-Dist: sparse
Requires-Dist: pint
Requires-Dist: bagit
Requires-Dist: openpyxl
Requires-Dist: rioxarray
Requires-Dist: geopandas
Requires-Dist: pyproj
Requires-Dist: shapely
Requires-Dist: hsclient
Requires-Dist: requests>=2.25
Requires-Dist: pyswmm<3,>=2
Requires-Dist: swmm-toolkit<0.17,>=0.15
Requires-Dist: swmmio<0.8.3
Requires-Dist: tabulate
Requires-Dist: notebook
Requires-Dist: jupyter_server
Requires-Dist: ipywidgets
Requires-Dist: globus-sdk>=3.0
Requires-Dist: plotly==5.24.1
Requires-Dist: kaleido!=0.2.1.post1,<1.0,>=0.2.1
Requires-Dist: datashader>=0.16
Requires-Dist: jinja2>=3.1
Requires-Dist: typer
Requires-Dist: rich
Requires-Dist: snakemake==9.15.0
Requires-Dist: rocrate==0.15.0
Provides-Extra: test
Requires-Dist: ruff==0.15.10; extra == "test"
Requires-Dist: ty; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-xdist>=3.0; extra == "test"
Requires-Dist: coverage; extra == "test"
Provides-Extra: viz-export
Provides-Extra: hpc
Requires-Dist: snakemake-executor-plugin-slurm<3,>=2.0; extra == "hpc"
Requires-Dist: snakemake-executor-plugin-slurm-jobstep<1,>=0.3; extra == "hpc"
Requires-Dist: snakemake-storage-plugin-fs==1.1.3; extra == "hpc"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Requires-Dist: mkdocs-htmlproofer-plugin; extra == "docs"
Dynamic: license-file

# H&H Ensemble Modeling Toolkit

![PyPI version](https://img.shields.io/pypi/v/hhemt.svg)
[![Documentation Status](https://readthedocs.org/projects/hhemt/badge/?version=latest)](https://hhemt.readthedocs.io/en/latest/?version=latest)

Tools for running and processing TRITON-SWMM models.

* PyPI package: https://pypi.org/project/hhemt/
* License: [PolyForm Noncommercial 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0/)
* Documentation: https://hhemt.readthedocs.io.

## Installation

The full toolkit — including SWMM hydrology execution — is validated only against
the conda environment shipped in this repo. This is the supported install:

```bash
conda env create -n hhemt --file environment.yaml
conda activate hhemt
pip install --no-deps "swmmio==0.8.5"
pip install -e . --no-deps
```

Both `--no-deps` steps are required. The validated SWMM engine (`swmm-toolkit`
0.15.x + `pyswmm` 2.0.1) is only available from conda-forge and cannot be
expressed as pip metadata, so a plain `pip install hhemt` installs an unvalidated
SWMM stack: everything except SWMM *execution* works, and SWMM execution fails
closed with an actionable error pointing here. See
[`docs/how-to/installation.md`](docs/how-to/installation.md) for details.

## Usage

```bash
hhemt --help          # CLI entry point
```

See the [documentation](https://hhemt.readthedocs.io) for the end-to-end
analysis workflow.

## How to cite

If you use this software, please cite it. Citation metadata is maintained in [`CITATION.cff`](CITATION.cff) (GitHub's "Cite this repository" resolves it). Once the first release is published, cite the specific version via its Zenodo DOI:

<!-- The Zenodo concept-DOI badge is added when the first release DOI is minted (first-public-release):
[![DOI](https://zenodo.org/badge/DOI/PLACEHOLDER.svg)](https://doi.org/PLACEHOLDER) -->

## Credits

This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
