Skip to content

UFSObsConv

Global

Import path: earth2studio.data.UFSObsConv

View source on GitHub

Documentation

Bases: _UFSObsBase

NOAA UFS GEFS-v13 replay observations in-situ data

Parameters:

  • time_tolerance (TimeTolerance, default: timedelta64(10, 'm') ) –

    Time tolerance window for filtering observations. Accepts a single value (symmetric ± window) or a tuple (lower, upper) for asymmetric windows, by default, np.timedelta64(10, 'm').

  • max_workers (int, default: 24 ) –

    Max workers in async IO thread pool for concurrent downloads, by default 24.

  • cache (bool, default: True ) –

    Cache data source in local filesystem cache, by default True.

  • async_timeout (int, default: 600 ) –

    Time in seconds after which the async fetch will be cancelled if not finished, by default 600.

  • verbose (bool, default: True ) –

    Log basic progress information, by default True.

  • decode_workers (int | Literal['auto'], default: 'auto' ) –

    Number of processes used to decode the fetched NetCDF files into DataFrames, or "auto" to select from the available CPUs. Use 1 to decode serially in the current process, by default "auto". Workers use the 'spawn' start method, so as with any use of multiprocessing, script entry points must be guarded by if __name__ == "__main__".

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:

Example 
ds = UFSObsConv(tolerance=timedelta(hours=2))
df = ds(datetime(2024, 1, 1, 20), ["u"])

__call__ 

__call__(
    time: datetime | list[datetime] | TimeArray,
    variable: str | list[str] | VariableArray,
    fields: str | list[str] | Schema | None = None,
) -> DataFrame

Fetch observations for a set of timestamps.

Parameters:

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

    Timestamps to return data for (UTC).

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

    DataFrame column names to return.

  • fields (str | list[str] | Schema | None, default: None ) –

    Fields to include in output, by default None (all fields).

fetch async 

fetch(
    time: datetime | list[datetime] | TimeArray,
    variable: str | list[str] | VariableArray,
    fields: str | list[str] | Schema | None = None,
) -> DataFrame

Async function to get data.

Examples using earth2studio.data.UFSObsConv

Preview of HealDA Global Data AssimilationHealDA Global Data AssimilationProducing a global weather analysis from satellite and in-situ observations.