data.DynamicalIFS_ENS_FX

Global

Import path: earth2studio.data.DynamicalIFS_ENS_FX

View source on GitHub

Documentation

Bases: _DynamicalBase

ECMWF IFS ENS (15 day, 0.25 degree) ensemble forecast from dynamical.org.

ECMWF Integrated Forecasting System ensemble forecasts (dimensions [time, lead_time, lat, lon]) on a global 0.25 degree regular latitude/longitude grid, out to 15 days from the 00 UTC initialization. A single ensemble member is selected via member.

Parameters:

• member (int, default: 0 ) –

  Ensemble member index to select, by default 0 (control member).

• cache (bool, default: True ) –

  Retained for API parity; Icechunk reads chunks lazily on demand rather than caching whole files locally, by default True

• verbose (bool, default: True ) –

  Print download progress, by default True

Examples:

>>> source = DynamicalIFS_ENS_FX()
>>> source.variables  # variables are determined dynamically

Warning

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

Note

The dynamical.org dataset documentation and STAC metadata are available at:

• dynamical.org/catalog/ecmwf-ifs-ens-forecast-15-day-0-25-degree/
• stac.dynamical.org/ecmwf-ifs-ens-forecast-15-day-0-25-degree/collection.json

__call__

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

Retrieve forecast data.

Parameters:

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

  Forecast initialization timestamps to return data for (UTC).

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

  Forecast lead times to return.

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

  Variable(s) to return, in the dynamical.org lexicon or native to the collection.

Returns:

• DataArray –

  Data array with dimensions [time, lead_time, variable, ...].

fetch async

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

Async function to retrieve forecast data.

Parameters:

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

  Forecast initialization timestamps to return data for (UTC).

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

  Forecast lead times to return.

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

  Variable(s) to return, in the dynamical.org lexicon or native to the collection.

Returns:

• DataArray –

  Data array with dimensions [time, lead_time, variable, ...].

available

available(time: datetime | datetime64) -> bool

Check if a given time is available in this dynamical.org collection.

Unlike most Earth2Studio sources, availability is collection-dependent (each collection advertises its own temporal extent in its STAC metadata), so this is an instance method rather than a classmethod: it opens the collection and checks the requested time against the extent of the collection's temporal dimension (time for analysis, init_time for forecast collections).

Parameters:

• time (datetime | datetime64) –

  Time to check. For forecast collections this is the forecast initialization time.

Returns:

• bool –

  Whether the time falls within the collection's temporal extent.