Skip to content

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

License

Notifications You must be signed in to change notification settings

hyriver/hysetter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HySetter: Hyroclimate Data Subsetter based on HyRiver

PyPi Conda Version CodeCov Python Versions Downloads

Security Status CodeFactor Ruff pre-commitBinder

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

Try HySetter in your browser by clicking on the Binder badge above.

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.

image{.align-center}

image{.align-center}

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.