Skip to content

SamudrACEData

Global

Import path: earth2studio.data.SamudrACEData

View source on GitHub

Documentation

Bases: _SamudrACEBase

SamudrACE initial-condition data source.

Provides the combined atmosphere and ocean initial-condition variables of the SamudrACE coupled emulator from the allenai/SamudrACE-CM4-piControl HuggingFace repository, served with Earth2Studio variable names via the SamudrACELexicon.

The SamudrACE checkpoint was trained on a GFDL CM4 preindustrial-control run, so initial conditions exist only at the published CM4 model-year timestamps (e.g. 0151-01-06T00:00:00); requesting any other time raises an error. Because such model years are outside the range of nanosecond-precision timestamps, times should be provided as second-precision np.datetime64 values or datetime objects, and the returned time coordinate is second precision.

Parameters:

  • cache (bool, default: True ) –

    Cache downloaded files locally (via the shared HuggingFace hub cache), by default True.

  • verbose (bool, default: True ) –

    Log download progress, by default True.

Warning

Each initial condition consists of two NetCDF files of roughly 100 MB total that are downloaded on demand.

Note

For more information see the following references:

__call__ 

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

Fetch initial-condition data.

Parameters:

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

    Timestamps to return data for. Every requested time must be one of the published initial-condition timestamps.

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

    Earth2Studio variable names (see SamudrACELexicon).

Returns:

  • DataArray –

    Data array with dimensions [time, variable, lat, lon] and latitude ordered north to south.

fetch async 

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

Async wrapper for __call__.

Parameters:

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

    Timestamps to return data for.

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

    Earth2Studio variable names.

Returns:

  • DataArray –

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