API

API#

Auto-generated summary of CloudDrift’s API. For more details and examples, refer to the different Jupyter Notebooks.

adapters.andro

This module defines functions used to adapt the ANDRO: An Argo-based deep displacement dataset as a ragged-arrays dataset.

adapters.gdp

This module provides functions and metadata to convert the Global Drifter Program (GDP) data to a clouddrift.RaggedArray instance.

adapters.gdp1h

This module provides functions and metadata that can be used to convert the hourly Global Drifter Program (GDP) data to a clouddrift.RaggedArray instance.

adapters.gdp6h

This module provides functions and metadata that can be used to convert the 6-hourly Global Drifter Program (GDP) data to a clouddrift.RaggedArray instance.

adapters.glad

This module defines functions used to adapt the Grand LAgrangian Deployment (GLAD) dataset as a ragged-array Xarray Dataset.

adapters.mosaic

This module defines functions used to adapt the MOSAiC sea-ice drift dataset as a ragged-array dataset.

adapters.subsurface_floats

This module defines functions to adapt as a ragged-array dataset a collection of data from 2193 trajectories of SOFAR, APEX, and RAFOS subsurface floats from 52 experiments across the world between 1989 and 2015.

adapters.yomaha

This module defines functions used to adapt the YoMaHa'07: Velocity data assessed from trajectories of Argo floats at parking level and at the sea surface as a ragged-arrays dataset.

datasets

This module provides functions to easily access ragged array datasets.

kinematics

Functions for kinematic computations.

pairs

Functions to analyze pairs of contiguous data segments.

plotting

This module provides a function to easily and efficiently plot the rows of a ragged array.

ragged

Transformational and inquiry functions for ragged arrays.

raggedarray

This module defines the RaggedArray class, which is the intermediate data structure used by CloudDrift to process custom Lagrangian datasets to Xarray Datasets and Awkward Arrays.

signal

This module provides signal processing functions.

sphere

This module provides functions for spherical geometry calculations.

wavelet

This module provides functions for computing wavelet transforms and time-frequency analyses, notably using generalized Morse wavelets.