HySetter: Hydroclimate Data Subsetter based on HyRiver
Features
HySetter is an open-source Python package, built on HyRiver software stack, that provides a command-line interface (CLI) and Python API for subsetting hydroclimate data from the following data sources over the conterminous United States (CONUS):
- Area Of Interest: From any HUC level, GAGES-II basins, NHDPlusV2 catchments and their attributes (StreamCat and NLDI), or a user-defined GeoDataFrame
- Drainage Network: From NHDPlusV2
- Forcing: From Daymet, GridMET, or NLDAS2
- Streamflow: From NWIS
- Soil: From gNATSGO, or SoilGrids
- Topography: From 3DEP
- Dam: From NID
- Land Use/Land Cover, Canopy, Imperviousness, and Urban Descriptor: From MRLC
Try HySetter in your browser by clicking on the Binder badge above. You can refer to the documentation for more examples and details.
Installation
You can install hysetter using pip:
pip install hysetter
Alternatively, hysetter can be installed from the conda-forge repository using
micromamba,
conda, or mamba:
micromamba install -c conda-forge hysetter
You can use conda or mamba instead of micromamba if you prefer, but micromamba
is recommended for its efficiency and ease of use.
For just installing HySetter's CLI, you can first install Pixi by following the its installation instructions for your platform. Then, you can install HySetter using the following command:
pixi global install hysetter
Quick start
Once HySetter is installed, you can use its CLI or Python API to subset hydroclimate data via a configuration file. The configuration file is a YAML file that specifies the data source, the area of interest (AOI), and the output directory. You can find an example configuration file in the config_demo.yml.
Contributing
Contributions are appreciated and very welcomed. Please read CONTRIBUTING.rst for instructions.
Acknowledgements
This work is supported by the Consortium of Universities for the Advancement of Hydrologic Science, Inc. (CUAHSI) through the Hydroinformatics Innovation Fellowship program.
1 maintainer
Metadata
1 maintainer
Release files for hysetter 0.3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| hysetter-0.3.4.tar.gz | 2.1 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hysetter-0.3.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.1 MB
Release files / hysetter-0.3.4.tar.gz
| Download URL | hysetter-0.3.4.tar.gz |
|---|---|
| Size | 2.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
26838f2501f8f478b872bec3dad04247c212f2a61e4c1c64ba1cb1532f880300
|
|
BLAKE2b-256 checksum How to use checksums |
1bdb41d18fc8ec3c31399ba0aff260fcdd9a92b43a282015702f81a5e5fc97c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 17, 2025.
Transparency logRelease files / hysetter-0.3.4-py3-none-any.whl
| Download URL | hysetter-0.3.4-py3-none-any.whl |
|---|---|
| Size | 25.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
347113c10fc4ab70ae7506f452c00adf4ecf433f5fc2bd2ee761f00471d5bd2f
|
|
BLAKE2b-256 checksum How to use checksums |
a732e37bdcfb1e8083a74506d47ccde64b6156c69a910105444f1e1fad5b842f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 17, 2025.
Transparency logSecurity for hysetter 0.3.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for hysetter-0.3.4.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 17, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
