This repo is meant to take OCONUS reference data products and convert them into reference-files that can be used in the NOAA-OWP/hydrofabric-builds Repository
The NHDPlusHR is used for PRVI and HI and can be downloaded in HUC4 form through: https://www.sciencebase.gov/catalog/item/57645ff2e4b07657d19ba8e8
the zipped geopackage is required
Since reference 0.1.6, The USGS Reference Hydrofabric is used for AK and can be downloaded for the entire state here (as VPU 19). This change was made to include more coastal areas for better NWM support: https://www.sciencebase.gov/catalog/item/6644f800d34e1955f5a42da9
the reference_19 geopackage is required
Prior to reference 0.1.6, GeoGlows v2 was used for the AK reference and the code to use it is still present. The source files can be downloaded from the following location:
- http://geoglows-v2.s3-website-us-west-2.amazonaws.com/#hydrography/vpu=801/
- http://geoglows-v2.s3-website-us-west-2.amazonaws.com/#hydrography/vpu=802/
- http://geoglows-v2.s3-website-us-west-2.amazonaws.com/#hydrography/vpu=803/
- http://geoglows-v2.s3-website-us-west-2.amazonaws.com/#hydrography/vpu=705/
the catchment.parquet and streams_mapping.gpkg files are required from each VPU
An archive called reference_builds_data.tar contains all needed data. Extract this file in repo root and rename the folder to data. This includes all data for NHDPlusHR, GeoGlows, and USGS reference data.
This data only needs to be unzipped in it's data/domain folder for it to be picked up by the example scripts. The folder data is required
All dependencies can be installed through:
uv sync
and the example configs can be used to create the references once the data is downloaded:
uv run python builds/build_reference.py --config config/example_prvi.yaml
uv run python builds/build_reference.py --config config/example_hi.yaml
uv run python builds/build_reference.py --config config/example_ak.yaml
Run test suite with:
pytest tests