HySetter

HySetter: A Python Package for Reproducible Hydroclimate Data Subsetting over CONUS - Published in JOSS (2025)

https://github.com/hyriver/hysetter

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
○
Academic email domains
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

climate-data daymet gridmet hydrology nldas nwis

Scientific Fields

Political Science Social Sciences - 90% confidence

Last synced: 4 months ago · JSON representation

Repository

A command-line tool for getting hydroclimate data within CONUS using HyRiver

Basic Info

Host: GitHub
Owner: hyriver
License: mit
Language: Python
Default Branch: main
Homepage: https://hysetter.readthedocs.io
Size: 7.72 MB

Statistics

Stars: 4
Watchers: 1
Forks: 2
Open Issues: 0
Releases: 8

Topics

climate-data daymet gridmet hydrology nldas nwis

Created over 1 year ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Authors

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:

console pip install hysetter

Alternatively, hysetter can be installed from the conda-forge repository using micromamba:

console 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:

console 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.

Owner

Name: HyRiver
Login: hyriver
Kind: organization
Location: United States of America

Website: https://docs.hyriver.io
Repositories: 11
Profile: https://github.com/hyriver

A suite of Python packages that provides a unified API for retrieving geospatial/temporal data from various web services

JOSS Publication

HySetter: A Python Package for Reproducible Hydroclimate Data Subsetting over CONUS

Published

July 18, 2025

DOI

10.21105/joss.08301

Volume 10, Issue 111, Page 8301

Authors

Taher Chegini

Lyles School of Civil Engineering, Purdue University, West Lafayette, IN, US

Editor

James Gaboardi

GitHub Events

Total

Create event: 8
Issues event: 4
Release event: 5
Watch event: 2
Delete event: 5
Issue comment event: 13
Push event: 18
Pull request event: 6
Fork event: 2

Last Year

Create event: 8
Issues event: 4
Release event: 5
Watch event: 2
Delete event: 5
Issue comment event: 13
Push event: 18
Pull request event: 6
Fork event: 2

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 3
Total pull requests: 2
Average time to close issues: 8 days
Average time to close pull requests: about 3 hours
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 2.33
Average comments per pull request: 0.0
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 2

Past Year

Issues: 3
Pull requests: 2
Average time to close issues: 8 days
Average time to close pull requests: about 3 hours
Issue authors: 1
Pull request authors: 1
Average comments per issue: 2.33
Average comments per pull request: 0.0
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 2

View more stats

Top Authors

Issue Authors

Zeitsperre (3)

Pull Request Authors

dependabot[bot] (5)

Top Labels

Issue Labels

bug (2) enhancement (1)

Pull Request Labels

dependencies (5)

Packages

Total packages: 1
Total downloads:
- pypi 33 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 7
Total maintainers: 1

pypi.org: hysetter

Subset hydroclimate data using HyRiver Over CONUS.

Homepage: https://hysetter.readthedocs.io
Documentation: https://hysetter.readthedocs.io/
License: MIT
Latest release: 0.3.4
published 6 months ago

Versions: 7
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 33 Last month

Rankings

Dependent packages count: 10.9%

Average: 36.2%

Dependent repos count: 61.5%

Maintainers (1)

tchegini