`EarthMoverBrightBandIFS`¶

GlobalIFSEarthMover

Import path: earth2studio.data.EarthMoverBrightBandIFS

Documentation¶

Bases: _EarthMoverBase

Brightband ECMWF IFS 0.25 degree initial-condition 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-initial-conditions-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-initial-conditions-open-subscription.

Arraylake-backed Earthmover sources require Python 3.12 or newer.

For a walkthrough of subscribing to a Marketplace listing, authenticating, fetching data and writing output back to Arraylake, see the blog post Access Earthmover Marketplace Data with Earth2Studio.

Additional information on the data repository can be referenced here:

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

Retrieve IFS analysis data for times and variables.

Parameters:

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

Analysis timestamps (UTC).
variable (str | list[str] | VariableArray) –

Earth2Studio variable id(s).

Returns:

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

Retrieve IFS analysis data for times and variables asynchronously.

Parameters:

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

Analysis timestamps (UTC).
variable (str | list[str] | VariableArray) –

Earth2Studio variable id(s).

Returns:

available(time: datetime | datetime64) -> bool

Synchronous wrapper for _available.