Skip to content

data.NCAR_ERA5

Global

Import path: earth2studio.data.NCAR_ERA5

View source on GitHub

Documentation

ERA5 data provided by NSF NCAR via the AWS Open Data Sponsorship Program. ERA5 is the fifth generation of the ECMWF global reanalysis and available on a 0.25 degree WGS84 grid at hourly intervals spanning from 1940 to the present.

Parameters:

  • max_workers (int, default: 24 ) –

    Deprecated, retained for backwards compatibility. Use async_workers to control download concurrency, by default 24

  • cache (bool, default: True ) – 
    Cache data source on local memory, by default True
  • verbose (bool, default: True ) –

    Print download progress, by default True

  • async_timeout (int, default: 600 ) –

    Timeout in seconds for async operations, by default 600

  • async_workers (int, default: None ) –

    Maximum number of concurrent downloads. By default None, which autoscales to the number of download tasks (capped at 64)

  • retries (int, default: 3 ) –

    Number of retries for each download task on transient errors, by default 3

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 resources: registry.opendata.aws/nsf-ncar-era5/

__call__ 

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

Function to get data

Parameters:

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

    Timestamps to return data for (UTC).

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

    String, list of strings or array of strings that refer to variables to return. Must be in the NCAR lexicon.

Returns:

  • DataArray –

    ERA5 weather data array from NCAR ERA5

fetch async 

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

Async function to get data

Parameters:

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

    Timestamps to return data for (UTC).

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

    String, list of strings or array of strings that refer to variables to return. Must be in the ARCO lexicon.

Returns:

  • DataArray –

    ERA5 weather data array from ARCO