Skip to content

data.HRRR_FX

NA

Import path: earth2studio.data.HRRR_FX

View source on GitHub

Documentation

Bases: HRRR

High-Resolution Rapid Refresh (HRRR) forecast source provides a North-American weather forecasts with hourly forecast runs developed by NOAA. This forecast source has hourly forecast steps up to a lead time of 48 hours. Data is provided on a Lambert conformal 3km grid at 1-hour intervals. The spatial dimensionality of HRRR data is [1059, 1799].

Parameters:

  • source (str, default: 'aws' ) –

    Data source to use ('aws', 'google', 'azure', 'nomads'), by default 'aws'

  • max_workers (int, default: 24 ) –

    Deprecated, has no effect. Kept for API compatibility, 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 ) –

    Time in sec after which download will be cancelled if not finished successfully, 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

48 hour forecasts are provided on 6 hour intervals. 18 hour forecasts are generated hourly.

Note

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 HRRR forecast data

Parameters:

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

    Timestamps to return data for (UTC).

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

    Forecast lead times to fetch.

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

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

Returns:

  • DataArray –

    HRRR forecast data array

fetch async 

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

Async function to get data

Parameters:

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

    Timestamps to return data for (UTC).

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

    Forecast lead times to fetch.

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

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

Returns:

  • DataArray –

    HRRR forecast data array

available classmethod 

available(time: datetime | datetime64) -> bool

Checks if given date time is avaliable in the HRRR object store. Uses S3 store

Parameters:

Returns:

  • bool –

    If date time is avaiable