clouddrift
📦 Distributions
👥 Social
Join the Email Distribution List
📚 Binders and examples
-
: MOSAiC get started (🧊 sea ice trajectories)
-
-
-
HYCOM-OceanTrack: A repository with notebook examples using
clouddriftwith a very large , analysis-ready cloud-optimized, Lagrangian dataset hosted in the cloud: HYCOM OceanTrack: Integrated HYCOM Eulerian Fields and Lagrangian Trajectories Dataset.
clouddrift is a Python package that accelerates the use of Lagrangian data for atmospheric, oceanic, and climate sciences.
It is funded by NSF EarthCube through the
EarthCube Capabilities Grant No. 2126413.
Read the documentation.
Using clouddrift
Start by reading the documentation.
Example Jupyter notebooks that showcase the library, as well as scripts to process various Lagrangian datasets, can be found in gdp-get-started, mosaic-get-started, hurdat2-get-started, or a demo for the EarthCube community workshop 2023.
Contributing and scope
We welcome and invite contributions from the community in any shape or form! Please visit our Contributing Guide to get Started 😃
The scope of clouddrift includes:
- Working with contiguous ragged-array data; for example, see the
clouddrift.raggedmodule. - Common scientific analysis of Lagrangian data, oceanographic or otherwise;
for example, see the
clouddrift.kinematics,clouddrift.signal, andclouddrift.waveletmodules. - Processing existing Lagrangian datasets into a common data structure and format;
for example, see the
clouddrift.adapters.mosaicmodule. - Making cloud-optimized ragged-array datasets easily accessible; for example,
see the
clouddrift.datasetsmodule.
If you have an idea that does not fit into the scope of clouddrift but you think
it should, please open an issue to discuss it.
Getting started
Install clouddrift
You can install the latest release of clouddrift using pip or conda.
Latest official release:
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 configuration (~/.condarc):
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
Development branch:
If you need the latest development version, you can install it directly from this GitHub repository.
pip:
In your existing virtual environment, you can use pip as follows.
- Get the code:
git clone https://github.com/cloud-drift/clouddrift
cd clouddrift/
- Install dependencies and local version of
clouddrift:
pip install .
Conda:
Using conda, you can proceed as follows.
- Get the code:
git clone https://github.com/cloud-drift/clouddrift
cd clouddrift/
- Create an environment as specified in the yml file with the required library dependencies:
conda env create -f environment.yml # creates a new env with the dependencies
2a. Make sure you created the environment by activating it:
conda activate clouddrift
- Finally, install the local version of
clouddrift:
pip install .
Installing clouddrift on unsupported platforms
One or more dependencies of clouddrift may not have pre-built wheels for
platforms like IBM Power9 or Raspberry Pi.
If you are using pip to install clouddrift and are getting errors during the
installation step, try installing clouddrift using Conda.
If you still have issues installing clouddrift, you may need to install system
dependencies first.
Please let us know by opening an
issue and we will do our
best to help you.
Found an issue or need help?
Please create a new issue here and provide as much detail as possible about your problem or question.
3 maintainers
Metadata
3 maintainers
Release files for clouddrift 0.48.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| clouddrift-0.48.1.tar.gz | 114.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| clouddrift-0.48.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 249.4 kB
Release files / clouddrift-0.48.1.tar.gz
| Download URL | clouddrift-0.48.1.tar.gz |
|---|---|
| Size | 114.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
827c98b77f3ad6188ba2491b25d415e393739d935ad3f9f3d6d18deb741d98ee
|
|
BLAKE2b-256 checksum How to use checksums |
3827bbe16b4f85abbc5f82e89f33fa64a3d73214210a349909ec925a4fc20f28
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 22, 2026.
Transparency logRelease files / clouddrift-0.48.1-py3-none-any.whl
| Download URL | clouddrift-0.48.1-py3-none-any.whl |
|---|---|
| Size | 134.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
357e5c104842d54b2239194fa20ba7b91223cb27c8fd1b48397e027e4e161cde
|
|
BLAKE2b-256 checksum How to use checksums |
2028b1cf1466617eb3b9aad264da40d2123385b95ac18a7daa90cb5a2503d614
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 22, 2026.
Transparency log
