Coldcast

Coldcast is a configurable downloader for hydrometric, radar, snow, NWP, reanalysis, and related station or gridded products. It exposes a single coldcast CLI: you define URL and filename patterns (and other options) in YAML so new upstream layouts rarely need code changes.

Hosted docs: https://coldcast.readthedocs.io/en/latest/

In this documentation

• User guide — install the tool, run the CLI, edit settings, wire in FEWS run info, and browse per-source pages.

• Python API — import Coldcast modules for tests, automation, or custom tooling (the CLI remains the primary interface).

If you are new here, start with Installation, then Command-line interface and Configuration.

User guide

• Installation
  • Requirements
  • Install from a clone (editable)
  • Running the CLI on Windows
  • Using Poetry
  • Optional: documentation build dependencies
  • External credentials
• Command-line interface
  • Positional Arguments
  • Named Arguments
  • Sub-commands
  • Dry-run
  • See also
• Configuration
  • Global keys
  • Per-source blocks
  • Bundled CSV assets
  • NOAA Grib Filter
• Run-info overrides
  • XML run info (--run-info-file)
  • NetCDF run info (--run-info-netcdf)
• Data sources
  • NOAA HRRR (NOAA_HRRR)
  • NOAA GFS (NOAA_GFS)
  • NOAA GEFS (NOAA_GEFS)
  • ECCC NWP (ECCC_NWP)
  • ECCC precip grids (ECCC_PRECIP_GRID)
  • ECCC radar composite (ECCC_RADAR)
  • ECCC GeoMet API (ECCC_API)
  • Alberta WISKI API (ALBERTA_API)
  • Dynamical catalog (DYNAMICAL_CATALOG)
  • USDA SNOTEL (SNOTEL)
  • Snowcast SWE (SNOWCAST)
  • GlobSnow (GLOBSNOW)
  • NOAA SNODAS (SNODAS)
  • ERA5 (ERA5)
  • ERA5-Land (ERA5_LAND)
  • ECMWF (ECMWF)
• Publishing on Read the Docs
  • Steps (for maintainers)
  • Troubleshooting

Python API

• Python API reference
  • coldcast.download
  • coldcast.settings
  • coldcast.run_info
  • coldcast.sources registry
  • coldcast.cli

Indices and tables

• Index

• Search Page