API

DWD

DMO

class wetterdienst.provider.dwd.dmo.api.DwdDmoRequest(parameter, dmo_type, start_issue=DwdForecastDate.LATEST, end_issue=None, start_date=None, end_date=None, station_group=None, lead_time=None, settings=None)

Implementation of sites for dmo sites

Parameters:

• parameter (list[str | DwdDmoParameter | Parameter] | None) – parameter(s) to be collected

• dmo_type (str | DwdDmoType) – dmo type, either small or large

• start_issue (str | datetime | DwdForecastDate) – start of issue of dmo which should be caught (DMO run at time XX:YY)

• end_issue (str | datetime | None) – end of issue

• start_date (str | datetime | None) – start date for filtering returned dataframe

• end_date (str | datetime | None) – end date

static adjust_datetime(datetime_)

Adjust datetime to DMO release frequency (9/12 hours). Datetime is floored to closest release time e.g. if hour is 14, it will be rounded to 12

Parameters:

datetime – datetime that is adjusted

Return type:

datetime

Returns:

adjusted datetime with floored hour

property issue_end

Required for typing

property issue_start

Required for typing

Mosmix

class wetterdienst.provider.dwd.mosmix.api.DwdMosmixRequest(parameter, mosmix_type, start_issue=DwdForecastDate.LATEST, end_issue=None, start_date=None, end_date=None, station_group=None, settings=None)

Implementation of sites for MOSMIX mosmix sites

Parameters:

• parameter (list[str | DwdMosmixParameter | Parameter] | None) – parameter(s) to be collected

• mosmix_type (str | DwdMosmixType) – mosmix type, either small or large

• start_issue (str | datetime | DwdForecastDate | None) – start of issue of mosmix which should be caught (Mosmix run at time XX:YY)

• end_issue (str | datetime | None) – end of issue

• start_date (str | datetime | None) – start date for filtering returned dataframe

• end_date (str | datetime | None) – end date

static adjust_datetime(datetime_)

Adjust datetime to MOSMIX release frequency, which is required for MOSMIX-L that is only released very 6 hours (3, 9, 15, 21). Datetime is floored to closest release time e.g. if hour is 14, it will be rounded to 9

Parameters:

datetime – datetime that is adjusted

Return type:

datetime

Returns:

adjusted datetime with floored hour

property issue_end

Required for typing

property issue_start

Required for typing

Observation

class wetterdienst.provider.dwd.observation.api.DwdObservationRequest(parameter, resolution, period=None, start_date=None, end_date=None, settings=None)

The DWDObservationStations class represents a request for a station list as provided by the DWD service.

Parameters:

• parameter (str | DwdObservationDataset | DwdObservationParameter | list[str | DwdObservationDataset | DwdObservationParameter]) – parameter set str/enumeration

• resolution (str | Resolution | DwdObservationResolution) – resolution str/enumeration

• period (str | Period | DwdObservationPeriod | list[str | Period | DwdObservationPeriod]) – period str/enumeration

• start_date (str | datetime | None) – start date to limit the stations_result

• end_date (str | datetime | None) – end date to limit the stations_result

classmethod describe_fields(dataset, resolution, period, language='en')

Parameters:

• dataset –

• resolution –

• period –

• language (str) –

Return type:

dict

Returns:

filter_by_station_id(station_id)

Method to filter stations_result by station ids

Parameters:

station_id (str | int | tuple[str, ...] | tuple[int, ...] | list[str] | list[int]) – list of stations_result that are requested

Returns:

df with filtered stations_result

Radar

class wetterdienst.provider.dwd.radar.api.DwdRadarValues(parameter, site=None, fmt=None, subset=None, elevation=None, start_date=None, end_date=None, resolution=None, period=None, settings=None)

API for DWD radar data requests.

Request radar data from different places on the DWD data repository.

• https://opendata.dwd.de/weather/radar/composite/

• https://opendata.dwd.de/weather/radar/sites/

• https://opendata.dwd.de/climate_environment/CDC/grids_germany/daily/radolan/

• https://opendata.dwd.de/climate_environment/CDC/grids_germany/hourly/radolan/

• https://opendata.dwd.de/climate_environment/CDC/grids_germany/5_minutes/radolan/

Parameters:

• parameter (str | DwdRadarParameter) – The radar moment to request

• site (DwdRadarSite | None) – Site/station if parameter is one of RADAR_PARAMETERS_SITES

• fmt (DwdRadarDataFormat | None) – Data format (BINARY, BUFR, HDF5)

• subset (DwdRadarDataSubset | None) – The subset (simple or polarimetric) for HDF5 data.

• start_date (str | datetime | DwdRadarDate | None) – Start date

• end_date (str | datetime | timedelta | None) – End date

• resolution (str | Resolution | DwdRadarResolution | None) – Time resolution for RadarParameter.RADOLAN_CDC, either daily or hourly or 5 minutes.

• period (str | Period | DwdRadarPeriod | None) – Period type for RadarParameter.RADOLAN_CDC

adjust_datetimes()

Adjust start_date and end_date attributes to match minute marks for respective RadarParameter.

• RADOLAN_CDC is always published at HH:50. https://opendata.dwd.de/climate_environment/CDC/grids_germany/daily/radolan/recent/bin/

• RW_REFLECTIVITY is published each 10 minutes. https://opendata.dwd.de/weather/radar/radolan/rw/

• RQ_REFLECTIVITY is published each 15 minutes. https://opendata.dwd.de/weather/radar/radvor/rq/

• All other radar formats are published in intervals of 5 minutes. https://opendata.dwd.de/weather/radar/composit/fx/ https://opendata.dwd.de/weather/radar/sites/dx/boo/

query()

Send request(s) and return generator of RadarResult instances.

Return type:

Iterator[RadarResult]

Returns:

Generator of RadarResult instances.

Road

class wetterdienst.provider.dwd.road.api.DwdRoadRequest(parameter, start_date=None, end_date=None, settings=None)

Parameters:

• parameter (list[str | Enum | Parameter]) – requested parameter(s)

• resolution – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data

EA

Hydrology

class wetterdienst.provider.ea.hydrology.api.EaHydrologyRequest(parameter, resolution, start_date=None, end_date=None, settings=None)

Parameters:

• parameter (list[str | EaHydrologyParameter | Parameter]) – requested parameter(s)

• resolution (str | EaHydrologyResolution | Resolution) – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data

Eaufrance

Hubeau

class wetterdienst.provider.eaufrance.hubeau.api.HubeauRequest(parameter, start_date=None, end_date=None, settings=None)

Parameters:

• parameter (list[str | Enum | Parameter]) – requested parameter(s)

• resolution – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data

ECCC

Observation

class wetterdienst.provider.eccc.observation.api.EcccObservationRequest(parameter, resolution, start_date=None, end_date=None, settings=None)

Download weather data from Environment and Climate Change Canada (ECCC). - https://www.canada.ca/en/environment-climate-change.html - https://www.canada.ca/en/services/environment/weather.html

Original code by Trevor James Smith. Thanks! - https://github.com/Zeitsperre/canada-climate-python

Parameters:

• parameter (list[str | EcccObservationParameter | Parameter]) – parameter or list of parameters that are being queried

• resolution (str | EcccObservationResolution | Resolution) – resolution of data

• start_date (str | datetime | None) – start date for values filtering

• end_date (str | datetime | None) – end date for values filtering

Geosphere

Observation

class wetterdienst.provider.geosphere.observation.api.GeosphereObservationRequest(parameter, resolution, start_date=None, end_date=None, settings=None)

Parameters:

• parameter (list[str | GeosphereObservationParameter | Parameter]) – requested parameter(s)

• resolution (str | GeosphereObservationResolution | Resolution) – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data

IMGW

Hydrology

class wetterdienst.provider.imgw.hydrology.api.ImgwHydrologyRequest(parameter, resolution, start_date=None, end_date=None, settings=None)

Parameters:

• parameter – requested parameter(s)

• resolution – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data

Meteorology

class wetterdienst.provider.imgw.meteorology.api.ImgwMeteorologyRequest(parameter, resolution, start_date=None, end_date=None, settings=None)

Parameters:

• parameter – requested parameter(s)

• resolution – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data

NOAA

GHCN

class wetterdienst.provider.noaa.ghcn.api.NoaaGhcnRequest(parameter, resolution, start_date=None, end_date=None, settings=None)

Parameters:

• parameter (list[str | NoaaGhcnParameter | Parameter]) – list of parameter strings or parameter enums being queried

• start_date (str | datetime | None) – start date for request or None if all data is requested

• end_date (str | datetime | None) – end date for request or None if all data is requested

National Weather Service

Observation

class wetterdienst.provider.nws.observation.api.NwsObservationRequest(parameter, start_date=None, end_date=None, settings=None)

Parameters:

• parameter (list[str | NwsObservationParameter | Parameter]) – requested parameter(s)

• resolution – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data

WSV

Observation

class wetterdienst.provider.wsv.pegel.api.WsvPegelRequest(parameter, start_date=None, end_date=None, settings=None)

Request class for WSV Pegelonline, a German river management facility and provider of river-based measurements for last 30 days

Parameters:

• parameter (list[str | WsvPegelParameter | Parameter]) – requested parameter(s)

• resolution – requested resolution

• period – requested period(s)

• start_date (str | datetime | None) – Start date for filtering stations_result for their available data

• end_date (str | datetime | None) – End date for filtering stations_result for their available data