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:

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.

Acknowledgements#

This work is supported by the Consortium of Universities for the Advancement of Hydrologic Science, Inc. (CUAHSI) through the Hydroinformatics Innovation Fellowship program.