HydroData

The HydroData data catalog, associated python functions hf_hydrodata, and API are products of the HydroFrame project and are designed to provide easy access to national hydrologic simulations generated using the National ParFlow model (ParFlow-CONUS1 and ParFlow-CONUS2) as well as a variety of other gridded model input datasets and point observations. Some of the datasets provided here are direct observations (e.g. USGS streamflow observations) while other are model outputs (e.g. ParFlow-CONUS2) or data products (e.g. remote sensing products).

This documentation provides: 1. Details on all of the datasets and variables that are available in the HydroData catalog 2. A set of tools and examples for how to access and work with this data for your own purposes.

Please note that to access any data you will need to first sign up for an account and get an API pin (this is summarized in the Getting Started section). Please also refer to our Data Use Policy and make sure to cite any data sources that you use (examples of how to obtain citations are provided in the API and the How To sections).

Getting Started contains installation instructions and a quick-start guide for obtaining gridded datasets and point observations. The sections on Available datasets and data products, Working with Gridded Data and Working with Point Observations provide more detail on the datasets and fields that are available. Full example jupyter workbook workflows for working with point observations are in How To and the Python API Refererence contains the full list of available functions.

Table of Contents

• Getting Started
  • Installation
  • Creating a HydroFrame API Account
  • QuickStart Guide
• Available datasets and data products
  • Datasets
  • Variables
  • Grids
  • Temporal Resolutions
  • Aggregations
  • Metadata
• Working with Gridded Data
  • Gridded Observation Methods
  • Filter Parameters
  • Metadata Descriptions
• Working with Point Observations
  • Point Observation Methods
  • Filter Parameters
  • Metadata Descriptions
  • How To
• Python API Refererence
  • hf_hydrodata package
• Data Use Policy