Installation

Required dependencies

CloudDrift requires the following dependencies:

• python (3.10 or later)

• aiohttp (3.8.4 or later)

• awkward (2.0.0 or later)

• fsspec (2022.3.0 or later)

• netcdf4 (1.6.4 or later)

• h5netcdf (1.3.0 or later)

• numpy (1.22.4 or later)

• pandas (1.3.4 or later)

• pyarrow (8.0.0 or later)

• tqdm (4.64.0 or later)

• requests (2.31.0 or later)

• scipy (1.11.2 or later)

• xarray (2023.5.0 or later)

• zarr (2.14.2 or later)

• tenacity (8.2.3 or later)

if you install CloudDrift using uv, pip or Conda, these dependencies will be installed automatically. See Installation instructions for details.

Optional dependencies

For plotting

• cartopy

• matplotlib

For development and testing

• build

• coverage

• docutils

• pytest

• mypy

• ruff

• twine

For building the documentation

• sphinx

• sphinx-book-theme

• sphinx-copybutton

Note: Optional plotting dependencies can be installed by specifying extras:

• with uv: uv add 'clouddrift[plotting]'

• with pip: pip install 'clouddrift[plotting]'

There is also clouddrift[all] to install all optional dependencies.

Installation instructions

You can install the latest release of CloudDrift using uv, pip, or Conda. You can also install the latest development (unreleased) version from GitHub.

Note

The uv instructions below require uv to be installed. To install it, run:

curl -LsSf https://astral.sh/uv/install.sh | sh

See the uv installation docs for other platforms and methods.

uv

In your project, type:

uv add clouddrift

To install optional dependencies needed by the clouddrift.plotting module, type:

uv add 'clouddrift[plotting]'

For local development, clone the repository and run:

uv sync

pip

In your virtual environment, type:

pip install clouddrift

To install optional dependencies needed by the clouddrift.plotting module, type:

pip install 'clouddrift[plotting]'

Conda

First add conda-forge to your channels in your Conda environment:

conda config --add channels conda-forge
conda config --set channel_priority strict

then install CloudDrift:

conda install clouddrift

To install optional dependencies needed by the clouddrift.plotting module, type:

conda install matplotlib cartopy

Developers

If you need the latest development version, clone the repository and use uv:

git clone https://github.com/Cloud-Drift/clouddrift
cd clouddrift
uv sync

Alternatively, install directly from GitHub using pip:

pip install git+https://github.com/Cloud-Drift/clouddrift

Running tests

To run the tests, first clone the repository and install dependencies with uv:

git clone https://github.com/cloud-drift/clouddrift
cd clouddrift
uv sync

Then, run the tests like this:

uv run pytest

A quick how-to guide is provided on the Usage page.