Skip to content

data.EarthMoverBrightBandIFS_FX

Global

Import path: earth2studio.data.EarthMoverBrightBandIFS_FX

View source on GitHub

Documentation

Bases: _EarthMoverBase

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

Parameters:

  • repo (str, default: None ) –

    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, default: DEFAULT_BRANCH ) –

    Repository branch to read, by default "main".

  • client (AsyncClient, default: None ) –

    Pre-authenticated Arraylake async client. When omitted, this data source uses the API key stored in EARTHMOVER_API_KEY, by default None.

  • cache (bool, default: True ) –

    Retained for API compatibility; Arraylake reads lazily via Icechunk, by default True.

  • verbose (bool, default: True ) –

    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__ 

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

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:

  • DataArray –

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

fetch async 

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

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:

  • DataArray –

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

available 

available(time: datetime | datetime64) -> bool

Synchronous wrapper for _available.