Skip to content

README.md

Latest commit

 

History

History
53 lines (35 loc) · 3.78 KB

README.md

File metadata and controls

53 lines (35 loc) · 3.78 KB

Western Water Datahub

The Western Water Datahub (WWDH) is an implementation of the OGC API suite of standards, enabling access to water data from various sources through a unified interface. It is designed to enhance data interoperability, accessibility, and discoverability across multiple water data platforms.

This project is a collaboration between the United States Bureau of Reclamation, the Center for Geospatial Solutions, and Western States Water Council.

Source Systems

The interface consolidates access to multiple water data sources, offering a standardized API pattern to retrieve information from different systems. The sources are listed below:

Data Source Variables OGC API Format Source URL Link
USBR/RISE Reservoir Storage/Release/Level/Evap (current/historical) Features, EDR 🔗
NRCS/SNOTEL Snow Water Equivalent (station, current/historical) Features, EDR 🔗
USGS/WMA Streamflow (current) Features, EDR 🔗
AWDB Streamflow (forecast) Features, EDR 🔗
USACE Reservoir Storage/Release/Level/Evap (forecast) Features, EDR 🔗
NOAA/QPF Precipitation (Raster forecast) Features 🔗
NOAA/RFC Streamflow (forecast) Features 🔗
NOAA/NOHRSC Snow Water/Depth (forecast) Maps 🔗
PRISM Precipitation (historical) EDR 🔗

To learn more about custom mappings, visit the Western Water Datahub Mappings directory.

Getting Started

In both development and containerized deployments, the server can be accessed at http://localhost:5005

Local Development

  • Spin up the redis db using docker compose up -d
  • To install dependencies run make deps
    • We use uv for dependency management and thus you should have it installed
  • To run the server run: make dev
  • To run tests run: make test

Containerized Deployment

The following command will spin up all infrastructure for a containerized deployment and build both the server and UI as docker images

docker compose --profile production up

(Note: in production we deploy the pygeoapi server as a container on cloud run as defined by the cloudbuild.yaml file)

Contributing

Contributions are welcome! Please open an issue or submit a pull request to help improve the project.

License

This project is licensed under the MIT license. See the LICENSE file for details.