Skip to content

hyriver/HyRiver-examples

Repository files navigation

Logo

Binder CI status

Examples Notebooks

HyRiver is a software stack consisting of six Python libraries that are designed to aid in watershed analysis through web services. Currently, this project only includes hydrology and climatology data within the US. Some major capabilities of HyRiver are as follows:

  • Easy access to many web services for subsetting data on the server side and returning the requests as masked Datasets or geopandas.GeoDataFrames.
  • Splitting large requests into smaller chunks since web services often limit the number of features per request. So the only bottleneck for subsetting the data is your local machine memory.
  • Navigating and subsetting the NHDPlus database (both medium- and high-resolution) using web services.
  • Cleaning up the vector NHDPlus data, fixing some common issues, and computing vector-based accumulation through a river network.
  • A URL inventory for some popular (and tested) web services.
  • Some utilities for manipulating the obtained data and their visualization.

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}
    }