hyriver / hysetter

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

HySetter: Hyroclimate 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) for subsetting hydroclimate data from the following data sources over 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

Citation

If you use any of HyRiver packages in your research, we appreciate citations:

@article{Chegini_2021,
    author = {Chegini, Taher and Li, Hong-Yi and Leung, L. Ruby},
    doi = {10.21105/joss.03175},
    journal = {Journal of Open Source Software},
    month = {10},
    number = {66},
    pages = {1--3},
    title = {{HyRiver: Hydroclimate Data Retriever}},
    volume = {6},
    year = {2021}
}

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

Quick start

Once HySetter is installed, you can use the CLI 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 Consortium of Universities for the Advancement of Hydrologic Science, Inc. (CUAHSI) through the Hydroinformatics Innovation Fellowship program.