Installation

The python module to help access the metadata in the hydrodat_catalog.yaml file can be installed in a python virtual environment using pip:

pip install git+ssh://git@github.com/HydroFrame-ML/hydrodata

Once the hydrodata package is installed you can use it for example:

import hydrodata.data_catalog.data_access

options = {
    "variable": "water_table_depth",
    "dataset": "conus1_baseline_mod",
    "grid": "conus1",
    "period": "daily",
    "file_type": "pfb"
}
# Get metadata about the entry in the row and the path names to the data files
entry = hydrodata.data_catalog.data_access.get_catalog_entry(options)
paths = hydrodata.data_catalog.data_access.get_file_paths(entry, start_time="2005-09-29", end_time="2005-10-03")