clouddrift.datasets.hurdat2

Contents

clouddrift.datasets.hurdat2#

clouddrift.datasets.hurdat2(basin: Literal['atlantic', 'pacific', 'both'] = 'both', decode_times: bool = True, tmp_path: str = '/tmp/clouddrift/hurdat2') → DataArray[source]#

Returns the revised hurricane database (HURDAT2) as a ragged array xarray dataset.

The function will first look for the ragged array dataset on the local filesystem. If it is not found, the dataset will be downloaded using the corresponding adapter function and stored for later access.

The upstream data is available at https://www.aoml.noaa.gov/hrd/hurdat/hurdat2.html.

Parameters#

basin“atlantic”, “pacific”, “both” (default)

Specify which ocean basin to download storm data for. Current available options are the Atlantic Ocean “atlantic”, Pacific Ocean “pacific” and, both “both” to download storm data for both oceans.

decode_timesbool, optional

If True, decode the time coordinate into a datetime object. If False, the time coordinate will be an int64 or float64 array of increments since the origin time indicated in the units attribute. Default is True.

Returns#

xarray.Dataset

HURDAT2 dataset as a ragged array.

Standard usage of the dataset.

>>> from clouddrift.datasets import hurdat2
>>> ds = hurdat2()
>>> ds
<xarray.Dataset>
Dimensions:                          (traj: ..., obs: ...)
Coordinates:
    atcf_identifier                  (traj) <U8 ...
    time                             (obs) datetime64[ns] ...
Dimensions without coordinates: traj, obs
Data variables: (12/23)
    basin                            (traj) <U2 ...
    year                             (traj) int64 ...
    rowsize                          (traj) int64 ...
    record_identifier                (obs) <U1 ...
    system_status                    (obs) <U2 ...
    ...                               ...
    max_med_wind_radius_nw           (obs) float64 ...
    max_high_wind_radius_ne          (obs) float64 ...
    max_high_wind_radius_se          (obs) float64 ...
    max_high_wind_radius_sw          (obs) float64 ...
    max_high_wind_radius_nw          (obs) float64 ...
    max_sustained_wind_speed_radius  (obs) float64 ...
Attributes:
    title:            HURricane DATa 2nd generation (HURDAT2)
    date_created:     ...
    publisher_name:   NOAA AOML Hurricane Research Division
    publisher_email:  AOML.HRDWebmaster@noaa.gov
    publisher_url:    https://www.aoml.noaa.gov/hrd/hurdat/Data_Storm.html
    institution:      NOAA Atlantic Oceanographic and Meteorological Laboratory
    summary:          The National Hurricane Center (NHC) conducts a post-sto...
...

To only retrieve records for the Atlantic Ocean basin.

>>> from clouddrift.datasets import hurdat2
>>> ds = hurdat2(basin="atlantic")
>>> ds
<xarray.Dataset>
...

Reference#

https://www.aoml.noaa.gov/hrd/hurdat/Data_Storm.html.

Contents