Ctrl+K

clouddrift.datasets.subsurface_floats

clouddrift.datasets.subsurface_floats#

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

Returns the subsurface floats dataset as a ragged array Xarray dataset.

The data is accessed from a public HTTPS server at NOAA’s Atlantic Oceanographic and Meteorological Laboratory (AOML) accessible at https://www.aoml.noaa.gov/phod/gdp/index.php.

The upstream data is available at https://www.aoml.noaa.gov/phod/float_traj/files/allFloats_12122017.mat.

This dataset of subsurface float observations was compiled by the WOCE Subsurface Float Data Assembly Center (WFDAC) in Woods Hole maintained by Andree Ramsey and Heather Furey and copied to NOAA/AOML in October 2014 (version 1) and in December 2017 (version 2). Subsequent updates will be included as additional appropriate float data, quality controlled by the appropriate principal investigators, is submitted for inclusion.

Note that these observations are collected by ALACE/RAFOS/Eurofloat-style acoustically-tracked, neutrally-buoyant subsurface floats which collect data while drifting beneath the ocean surface. These data are the result of the effort and resources of many individuals and institutions. You are encouraged to acknowledge the work of the data originators and Data Centers in publications arising from use of these data.

The float data were originally divided by project at the WFDAC. Here they have been compiled in a single Matlab data set. See here for more information on the variables contained in these files.

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

Subsurface floats dataset as a ragged array

Examples#

>>> from clouddrift.datasets import subsurface_floats
>>> ds = subsurface_floats()
>>> ds
<xarray.Dataset>
Dimensions:   (traj: 2193, obs: 1402840)
Coordinates:
    id        (traj) uint16 ...
    time      (obs) datetime64[ns] ...
Dimensions without coordinates: traj, obs
Data variables: (12/13)
    expList   (traj) object ...
    expName   (traj) object ...
    expOrg    (traj) object ...
    expPI     (traj) object ...
    indexExp  (traj) uint8 ...
    fltType   (traj) object ...
    ...        ...
    lon       (obs) float64 ...
    lat       (obs) float64 ...
    pres      (obs) float64 ...
    temp      (obs) float64 ...
    ve        (obs) float64 ...
    vn        (obs) float64 ...
Attributes:
    title:            Subsurface float trajectories dataset
    history:          December 2017 (version 2)
    date_created:     2023-11-14T22:30:38.831656
    publisher_name:   WOCE Subsurface Float Data Assembly Center and NOAA AOML
    publisher_url:    https://www.aoml.noaa.gov/phod/float_traj/data.php
    license:          freely available
    acknowledgement:  Maintained by Andree Ramsey and Heather Furey from the ...

References#

WOCE Subsurface Float Data Assembly Center (WFDAC) https://www.aoml.noaa.gov/phod/float_traj/index.php

Contents