Skip to content

IFS_ENS

GlobalIFSECMWF

Import path: earth2studio.data.IFS_ENS

View source on GitHub

Documentation

Bases: _ECMWFOpenDataSource

Integrated forecast system (IFS) ensemble (ENS) initial state 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 available through the AWS and Google Cloud mirrors (sources aws and google).

Parameters:

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

    Open-data mirror to fetch from: "aws", "ecmwf", "azure", or "google". By default "aws".

  • member (int, default: 1 ) –

    Ensemble member id to use. If 0 the control forecast will be requested, if greater than 0 perturbed ensemble member will be requested, by default 1.

  • 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.

  • client_kwargs (dict[str, Any], default: {} ) –

    Additional keyword arguments passed to ecmwf.opendata.Client, by default {}.

Warning

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

Note

Accumulated variables are provided from previous forecast cycles using forecast predictions that verify at the requested analysis time.

Additional information on the data repository can be referenced here:

__call__ 

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

Retrieve IFS ENS data.

Parameters:

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

    Timestamps to return data for (UTC).

  • 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 ENS initial state data array.

fetch async 

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

Async method to retrieve IFS ENS initial state data.

Parameters:

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

    Timestamps to return data for (UTC).

  • 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 ENS initial state data array.