Command-line interface

The entry point is the coldcast program. The main workflow is:

coldcast download <source> [options]

where <source> is one of the subcommands listed below (e.g. noaa_hrrr, era5). Names are case-insensitive; uppercase aliases (e.g. NOAA_HRRR) are accepted.

The following reference is generated from the live argparse definition in coldcast.cli.

Coldcast data downloader

usage: coldcast [-h] [--log-file PATH] {download} ...

Positional Arguments

command

Possible choices: download

Named Arguments

--log-file

Append log messages to this file (default: ‘coldcast_download.log’)

Default: 'coldcast_download.log'

Sub-commands

download

Download data for a source

coldcast download [-h]
                  {noaa_hrrr,NOAA_HRRR,noaa_gfs,NOAA_GFS,noaa_gefs,NOAA_GEFS,alberta_api,ALBERTA_API,eccc_nwp,ECCC_NWP,eccc_precip_grid,ECCC_PRECIP_GRID,eccc_radar,ECCC_RADAR,eccc_api,ECCC_API,eccc_water_office,ECCC_WATER_OFFICE,dynamical_catalog,DYNAMICAL_CATALOG,snotel,SNOTEL,snowcast,SNOWCAST,globsnow,GLOBSNOW,snodas,SNODAS,era5,ERA5,era5_land,ERA5_LAND,ecmwf,ECMWF,ecmwf_nwp,ECMWF_NWP}
                  ...

Positional Arguments

data_source

Possible choices: noaa_hrrr, NOAA_HRRR, noaa_gfs, NOAA_GFS, noaa_gefs, NOAA_GEFS, alberta_api, ALBERTA_API, eccc_nwp, ECCC_NWP, eccc_precip_grid, ECCC_PRECIP_GRID, eccc_radar, ECCC_RADAR, eccc_api, ECCC_API, eccc_water_office, ECCC_WATER_OFFICE, dynamical_catalog, DYNAMICAL_CATALOG, snotel, SNOTEL, snowcast, SNOWCAST, globsnow, GLOBSNOW, snodas, SNODAS, era5, ERA5, era5_land, ERA5_LAND, ecmwf, ECMWF, ecmwf_nwp, ECMWF_NWP

Sub-commands

noaa_hrrr (NOAA_HRRR)

Download NOAA_HRRR data

coldcast download noaa_hrrr [-h] [--settings SETTINGS]
                            [--run-info-file RUN_INFO_FILE]
                            [--run-info-netcdf RUN_INFO_NETCDF]
                            [--output-dir OUTPUT_DIR]
                            [--max-threads MAX_THREADS] [--model MODEL]
                            [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

noaa_gfs (NOAA_GFS)

Download NOAA_GFS data

coldcast download noaa_gfs [-h] [--settings SETTINGS]
                           [--run-info-file RUN_INFO_FILE]
                           [--run-info-netcdf RUN_INFO_NETCDF]
                           [--output-dir OUTPUT_DIR]
                           [--max-threads MAX_THREADS] [--model MODEL]
                           [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

noaa_gefs (NOAA_GEFS)

Download NOAA_GEFS data

coldcast download noaa_gefs [-h] [--settings SETTINGS]
                            [--run-info-file RUN_INFO_FILE]
                            [--run-info-netcdf RUN_INFO_NETCDF]
                            [--output-dir OUTPUT_DIR]
                            [--max-threads MAX_THREADS] [--model MODEL]
                            [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

alberta_api (ALBERTA_API)

Download ALBERTA_API data

coldcast download alberta_api [-h] [--settings SETTINGS]
                              [--run-info-file RUN_INFO_FILE]
                              [--run-info-netcdf RUN_INFO_NETCDF]
                              [--output-dir OUTPUT_DIR]
                              [--max-threads MAX_THREADS] [--model MODEL]
                              [--dry-run] [--stations-csv PATH]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

--stations-csv

Station mapping CSV override. ECCC_API: station_csv_hydro / station_csv_meteo; ALBERTA_API: mapping_csv; ECCC_WATER_OFFICE: station_csv

eccc_nwp (ECCC_NWP)

Download ECCC_NWP data

coldcast download eccc_nwp [-h] [--settings SETTINGS]
                           [--run-info-file RUN_INFO_FILE]
                           [--run-info-netcdf RUN_INFO_NETCDF]
                           [--output-dir OUTPUT_DIR]
                           [--max-threads MAX_THREADS] [--model MODEL]
                           [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

eccc_precip_grid (ECCC_PRECIP_GRID)

Download ECCC_PRECIP_GRID data

coldcast download eccc_precip_grid [-h] [--settings SETTINGS]
                                   [--run-info-file RUN_INFO_FILE]
                                   [--run-info-netcdf RUN_INFO_NETCDF]
                                   [--output-dir OUTPUT_DIR]
                                   [--max-threads MAX_THREADS] [--model MODEL]
                                   [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

eccc_radar (ECCC_RADAR)

Download ECCC_RADAR data

coldcast download eccc_radar [-h] [--settings SETTINGS]
                             [--run-info-file RUN_INFO_FILE]
                             [--run-info-netcdf RUN_INFO_NETCDF]
                             [--output-dir OUTPUT_DIR]
                             [--max-threads MAX_THREADS] [--model MODEL]
                             [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

eccc_api (ECCC_API)

Download ECCC_API data

coldcast download eccc_api [-h] [--settings SETTINGS]
                           [--run-info-file RUN_INFO_FILE]
                           [--run-info-netcdf RUN_INFO_NETCDF]
                           [--output-dir OUTPUT_DIR]
                           [--max-threads MAX_THREADS] [--model MODEL]
                           [--dry-run] [--stations-csv PATH]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

--stations-csv

Station mapping CSV override. ECCC_API: station_csv_hydro / station_csv_meteo; ALBERTA_API: mapping_csv; ECCC_WATER_OFFICE: station_csv

eccc_water_office (ECCC_WATER_OFFICE)

Download ECCC_WATER_OFFICE data

coldcast download eccc_water_office [-h] [--settings SETTINGS]
                                    [--run-info-file RUN_INFO_FILE]
                                    [--run-info-netcdf RUN_INFO_NETCDF]
                                    [--output-dir OUTPUT_DIR]
                                    [--max-threads MAX_THREADS]
                                    [--model MODEL] [--dry-run]
                                    [--stations-csv PATH]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

--stations-csv

Station mapping CSV override. ECCC_API: station_csv_hydro / station_csv_meteo; ALBERTA_API: mapping_csv; ECCC_WATER_OFFICE: station_csv

dynamical_catalog (DYNAMICAL_CATALOG)

Download DYNAMICAL_CATALOG data

coldcast download dynamical_catalog [-h] [--settings SETTINGS]
                                    [--run-info-file RUN_INFO_FILE]
                                    [--run-info-netcdf RUN_INFO_NETCDF]
                                    [--output-dir OUTPUT_DIR]
                                    [--max-threads MAX_THREADS]
                                    [--model MODEL] [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

snotel (SNOTEL)

Download SNOTEL data

coldcast download snotel [-h] [--settings SETTINGS]
                         [--run-info-file RUN_INFO_FILE]
                         [--run-info-netcdf RUN_INFO_NETCDF]
                         [--output-dir OUTPUT_DIR] [--max-threads MAX_THREADS]
                         [--model MODEL] [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

snowcast (SNOWCAST)

Download SNOWCAST data

coldcast download snowcast [-h] [--settings SETTINGS]
                           [--run-info-file RUN_INFO_FILE]
                           [--run-info-netcdf RUN_INFO_NETCDF]
                           [--output-dir OUTPUT_DIR]
                           [--max-threads MAX_THREADS] [--model MODEL]
                           [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

globsnow (GLOBSNOW)

Download GLOBSNOW data

coldcast download globsnow [-h] [--settings SETTINGS]
                           [--run-info-file RUN_INFO_FILE]
                           [--run-info-netcdf RUN_INFO_NETCDF]
                           [--output-dir OUTPUT_DIR]
                           [--max-threads MAX_THREADS] [--model MODEL]
                           [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

snodas (SNODAS)

Download SNODAS data

coldcast download snodas [-h] [--settings SETTINGS]
                         [--run-info-file RUN_INFO_FILE]
                         [--run-info-netcdf RUN_INFO_NETCDF]
                         [--output-dir OUTPUT_DIR] [--max-threads MAX_THREADS]
                         [--model MODEL] [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

era5 (ERA5)

Download ERA5 data

coldcast download era5 [-h] [--settings SETTINGS]
                       [--run-info-file RUN_INFO_FILE]
                       [--run-info-netcdf RUN_INFO_NETCDF]
                       [--output-dir OUTPUT_DIR] [--max-threads MAX_THREADS]
                       [--model MODEL] [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

era5_land (ERA5_LAND)

Download ERA5_LAND data

coldcast download era5_land [-h] [--settings SETTINGS]
                            [--run-info-file RUN_INFO_FILE]
                            [--run-info-netcdf RUN_INFO_NETCDF]
                            [--output-dir OUTPUT_DIR]
                            [--max-threads MAX_THREADS] [--model MODEL]
                            [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

ecmwf (ECMWF, ecmwf_nwp, ECMWF_NWP)

Download ECMWF data

coldcast download ecmwf [-h] [--settings SETTINGS]
                        [--run-info-file RUN_INFO_FILE]
                        [--run-info-netcdf RUN_INFO_NETCDF]
                        [--output-dir OUTPUT_DIR] [--max-threads MAX_THREADS]
                        [--model MODEL] [--dry-run]
Named Arguments
--settings

Path to YAML settings file

--run-info-file

Optional FEWS run_info XML file

--run-info-netcdf

Optional run info netCDF file (sets reference time)

--output-dir

Override output directory

--max-threads

Override max threads

--model

Model name (for model-based sources)

--dry-run

Print URLs only, do not download

Default: False

When --output-dir is provided and the directory does not exist, Coldcast creates it automatically.

Dry-run

With --dry-run, Coldcast prints the URLs (or job list) that would be used and does not download. Sources that use custom download paths (for example GeoMet-style APIs, regional station services, CDS jobs, or ECMWF open-data clients) still run their planners; exact behavior is documented on each source page.

See also