data.CAMS_FX

Global

Import path: earth2studio.data.CAMS_FX

View source on GitHub

Documentation

CAMS Global atmospheric composition forecast data source.

Uses the cams-global-atmospheric-composition-forecasts dataset. Grid is 0.4 deg global (451 x 900).

Parameters:

• cache (bool, default: True ) –

  Cache data source on local memory, by default True

• verbose (bool, default: True ) –

  Print download progress, by default True

Warning

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

Note

Additional information on the data repository, registration, and authentication can be referenced here:

• ads.atmosphere.copernicus.eu/datasets/cams-global-atmospheric-composition-forecasts

• ads.atmosphere.copernicus.eu/how-to-api

  The API endpoint for this data source varies from the Climate Data Store (CDS), be sure your api config has the correct url.

__call__

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

Retrieve CAMS Global forecast data.

Parameters:

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

  Forecast initialization times (UTC).

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

  Forecast lead times.

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

  Variables to return. Must be in CAMSGlobalLexicon.

Returns:

• DataArray –

  CAMS forecast data array with dims [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

Async retrieval of CAMS Global forecast data.

Parameters:

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

  Forecast initialization times (UTC).

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

  Forecast lead times.

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

  Variables to return. Must be in CAMSGlobalLexicon.

Returns:

• DataArray –

  CAMS forecast data array with dims [time, lead_time, variable, lat, lon]

available classmethod

available(time: datetime | list[datetime]) -> bool

Check if CAMS Global forecast data is available for the requested times.

Parameters:

• time (datetime | list[datetime]) –

  Timestamps to check availability for.

Returns:

• bool –

  True if all requested times are within the valid range.