EarthMoverBrightBandIFS_FX#

class earth2studio.data.EarthMoverBrightBandIFS_FX(
repo=None,
branch='main',
client=None,
cache=True,
verbose=True,
)[source]#
GlobalForecast

Brightband ECMWF IFS 0.1 degree (10km) 15-day forecast data source on Earthmover Arraylake.

Parameters:

  • repo (str, optional) – Arraylake repository name as org/repo. When omitted, derives the repo from EARTHMOVER_ORGANIZATION as <org>/ecmwf-ifs-15-day-forecast-open-subscription, by default None.

  • branch (str, optional) – Repository branch to read, by default “main”.

  • client (arraylake.AsyncClient, optional) – Pre-authenticated Arraylake async client. When omitted, this data source uses the API key stored in EARTHMOVER_API_KEY, by default None.

  • cache (bool, optional) – Retained for API compatibility; Arraylake reads lazily via Icechunk, by default True.

  • verbose (bool, optional) – Print progress, by default True.

Warning

This is a remote data source and can download a large amount of data for large requests.

Note

Configure Earthmover access before using this data source:

  • Set the EARTHMOVER_API_KEY environment variable to an Earthmover / Arraylake API key, unless passing a pre-authenticated client.

  • Pass repo="org/repo" to open a specific Arraylake repository.

  • If repo is omitted, set the EARTHMOVER_ORGANIZATION environment variable. The default repository is <EARTHMOVER_ORGANIZATION>/ecmwf-ifs-15-day-forecast-open-subscription.

Arraylake-backed Earthmover sources require Python 3.12 or newer.

Additional information on the data repository can be referenced here:

__call__(time, lead_time, variable)[source]#

Retrieve IFS forecast data for init times, lead times and variables.

Parameters:

  • time (datetime | list[datetime] | TimeArray) – Forecast initialization timestamps (UTC).

  • lead_time (timedelta | list[timedelta] | LeadTimeArray) – Forecast lead times.

  • variable (str | list[str] | VariableArray) – Earth2Studio variable id(s).

Returns:

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

Return type:

xr.DataArray

async fetch(time, lead_time, variable)[source]#

Retrieve IFS forecast data asynchronously.

Parameters:

  • time (datetime | list[datetime] | TimeArray) – Forecast initialization timestamps (UTC).

  • lead_time (timedelta | list[timedelta] | LeadTimeArray) – Forecast lead times.

  • variable (str | list[str] | VariableArray) – Earth2Studio variable id(s).

Returns:

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

Return type:

xr.DataArray

available(time)[source]#

Synchronous wrapper for _available().

Parameters:

time (datetime | datetime64)

Return type:

bool