Skip to content

data.DynamicalHRRR_FX

NA

Import path: earth2studio.data.DynamicalHRRR_FX

View source on GitHub

Documentation

Bases: _DynamicalBase

NOAA HRRR 48-hour virtual forecast from the dynamical.org catalog.

NOAA High-Resolution Rapid Refresh forecasts on the native 3 km Lambert conformal CONUS grid. Data are returned on projection dimensions [y, x] with 2D lat/lon coordinates.

Parameters:

  • cache (bool, default: True ) –

    Retained for API parity; Icechunk reads chunks lazily on demand rather than caching whole files locally, by default True

  • verbose (bool, default: True ) –

    Print download progress, by default True

Examples:

>>> source = DynamicalHRRR_FX()
>>> source.variables  # variables are determined dynamically
Warning

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

Note

The dynamical.org dataset documentation and STAC metadata are available at:

__call__ 

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

Retrieve forecast data.

Parameters:

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

    Forecast initialization timestamps to return data for (UTC).

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

    Forecast lead times to return.

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

    Variable(s) to return, in the dynamical.org lexicon or native to the collection.

Returns:

  • DataArray –

    Data array with dimensions [time, lead_time, variable, ...].

fetch async 

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

Async function to retrieve forecast data.

Parameters:

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

    Forecast initialization timestamps to return data for (UTC).

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

    Forecast lead times to return.

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

    Variable(s) to return, in the dynamical.org lexicon or native to the collection.

Returns:

  • DataArray –

    Data array with dimensions [time, lead_time, variable, ...].

available 

available(time: datetime | datetime64) -> bool

Check if a given time is available in this dynamical.org collection.

Unlike most Earth2Studio sources, availability is collection-dependent (each collection advertises its own temporal extent in its STAC metadata), so this is an instance method rather than a classmethod: it opens the collection and checks the requested time against the extent of the collection's temporal dimension (time for analysis, init_time for forecast collections).

Parameters:

  • time (datetime | datetime64) –

    Time to check. For forecast collections this is the forecast initialization time.

Returns:

  • bool –

    Whether the time falls within the collection's temporal extent.