clouddrift.datasets.spotters

Contents

clouddrift.datasets.spotters#

clouddrift.datasets.spotters(decode_times: bool = True) Dataset[source]#

Returns the Sofar Ocean Spotter drifters ragged array dataset as an Xarray dataset.

The data is accessed from a zarr archive hosted on a public AWS S3 bucket accessible at https://sofar-spotter-archive.s3.amazonaws.com/spotter_data_bulk_zarr.

Parameters#

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

Sofar ocean floats dataset as a ragged array

Examples#

>>> from clouddrift.datasets import spotters
>>> ds = spotters()
>>> ds
<xarray.Dataset>
Dimensions:                (index: 6390651, trajectory: 871)
Coordinates:
    time                   (index) datetime64[ns] ...
  * trajectory             (trajectory) object 'SPOT-010001' ... 'SPOT-1975'
Dimensions without coordinates: index
Data variables:
    latitude               (index) float64 ...
    longitude              (index) float64 ...
    meanDirection          (index) float64 ...
    meanDirectionalSpread  (index) float64 ...
    meanPeriod             (index) float64 ...
    peakDirection          (index) float64 ...
    peakDirectionalSpread  (index) float64 ...
    peakPeriod             (index) float64 ...
    rowsize                (trajectory) int64 ...
    significantWaveHeight  (index) float64 ...
Attributes:
    author:         Isabel A. Houghton
    creation_date:  2023-10-18 00:43:55.333537
    email:          isabel.houghton@sofarocean.com
    institution:    Sofar Ocean
    references:     https://content.sofarocean.com/hubfs/Spotter%20product%20...
    source:         Spotter wave buoy
    title:          Sofar Spotter Data Archive - Bulk Wave Parameters