data.IFS_FX

Global

Import path: earth2studio.data.IFS_FX

View source on GitHub

Documentation

Bases: _ECMWFOpenDataSource

Integrated forecast system (IFS) HRES forecast data source on an equirectangular grid at 0.25 degree resolution. IFS is a forecast model developed by ECMWF. Data for the most recent 4 days can be retrieved from ECMWF's servers (source ecmwf). Historical data is part of ECMWF's open data project on AWS (source aws).

Parameters:

• source (str, default: 'aws' ) –

  Data source to fetch data from. For possible options refer to ECMWF's open data Python SDK, by default "aws".

• cache (bool, default: True ) –

  Cache data source in local memory, by default True.

• verbose (bool, default: True ) –

  Print download progress, by default True.

• async_timeout (int, default: 600 ) –

  Time in seconds after which the download will be cancelled if not finished successfully, by default 600.

Warning

This is a remote data source and can potentially download a large amount of data to your local machine for large requests.

Note

Additional information on the data repository can be referenced here:

• ecmwf/ecmwf-opendata
• confluence.ecmwf.int/display/DAC/ECMWF+open+data%3A+real-time+forecasts
• registry.opendata.aws/ecmwf-forecasts/
• console.cloud.google.com/storage/browser/ecmwf-open-data/

__call__

__call__(
    time: datetime | list[datetime] | TimeArray,
    lead_time: timedelta | list[timedelta] | LeadTimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

Retrieve IFS forecast data.

Parameters:

• time (datetime | list[datetime] | TimeArray) –

  Timestamps to return data for (UTC).

• lead_time (timedelta | list[timedelta] | LeadTimeArray) –

  Forecast lead times to fetch.

• variable (str | list[str] | VariableArray) –

  String, list of strings or array of strings that refer to variables to return. Must be in the data lexicon.

Returns:

• DataArray –

  IFS forecast data array

fetch async

fetch(
    time: datetime | list[datetime] | TimeArray,
    lead_time: timedelta | list[timedelta] | LeadTimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

Async method to retrieve IFS forecast data.

Parameters:

• time (datetime | list[datetime] | TimeArray) –

  Timestamps to return data for (UTC).

• lead_time (timedelta | list[timedelta] | LeadTimeArray) –

  Forecast lead times to fetch.

• variable (str | list[str] | VariableArray) –

  String, list of strings or array of strings that refer to variables to return. Must be in the data lexicon.

Returns:

• DataArray –

  IFS forecast data array.