Skip to content

Data Sources

Salvador Navas edited this page Jul 2, 2026 · 1 revision

Data Sources

pyhydra.data_sources groups downloaders and readers for hydroclimatic input data. Network services can change, require credentials or impose rate limits, so these functions should be used with reproducibility logs and local caching.

Rainfall

Package: pyhydra.data_sources.rainfall

Source Main API Notes
GPM / IMERG GPMDownloader Satellite precipitation workflows; may require NASA Earthdata setup depending on use.
ERA5 download_era5 Uses Copernicus/CDS infrastructure.
PERSIANN PERSSIANDownloader PERSIANN rainfall download helper.
AEMET download_aemet_daily_data, AEMETDownloader, AemetCSVLoader, fetch_station_inventory Requires AEMET OpenData API key for downloads.
OGIMET OGIMETDownloader, download_synop, OgimetCSVLoader, process_all_meteorological_variables SYNOP-oriented workflows and CSV loading.
Meteostat MeteostatDownloader, download_meteostat_series, select_best_meteostat_station, MeteostatCSVLoader Station discovery, scoring and time-series download helpers.

Example:

from pyhydra.data_sources.rainfall import MeteostatDownloader

# See the notebook examples for complete station and date configuration.

River Discharge

Package: pyhydra.data_sources.river_discharge

Source Main API Notes
GRDC read_grdc, read_grdc_metadata, read_grdc_folder, analyze_grdc_quality Reads local GRDC text files.
USGS NWIS download_usgs, get_usgs_site_info, search_usgs_sites US station search and daily streamflow downloads.
GloFAS download_glofas, download_glofas_by_year, read_glofas_nc Copernicus-based global discharge data.

Climate-Change Data

Package: pyhydra.data_sources.climate_change

Source Main API Notes
Copernicus/CDS download_CDS_CMIP6 CMIP6 download helper through CDS workflows.
ESGF get_dataset_metadata, get_all_urls, get_combination_if_complete, download_file, process_file ESGF discovery, file listing, download and spatial subsetting helpers.

Soils

Package: pyhydra.data_sources.soils

Main APIs:

  • download_soilgrids
  • open_soilgrids_geotif
  • find_usda_soilclass
  • create_new_tif
  • convert_depth_to_soilclass
  • extract_mode_soilclass

These functions support SoilGrids downloads and raster conversion toward USDA soil classes. Raster processing may require geospatial dependencies.

Reproducibility Guidance

For any data-source workflow, store:

  • query dates and bounding boxes;
  • API credentials used, without committing secrets;
  • package version or commit hash;
  • source service and product version where available;
  • local file paths and checksums for downloaded datasets.

Clone this wiki locally