Clouddrift

Clouddrift: a Python package to accelerate the use of Lagrangian data for atmospheric, oceanic, and climate sciences - Published in JOSS (2024)

https://github.com/cloud-drift/clouddrift

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 7 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org, zenodo.org
✓
Committers with academic emails
2 of 9 committers (22.2%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

climate-data climate-science data-structures oceanography python

Scientific Fields

Mathematics Computer Science - 84% confidence

Last synced: 6 months ago · JSON representation

Repository

CloudDrift accelerates the use of Lagrangian data for atmospheric, oceanic, and climate sciences.

Basic Info

Host: GitHub
Owner: Cloud-Drift
License: mit
Language: Python
Default Branch: main
Homepage: https://clouddrift.org/
Size: 6.33 MB

Statistics

Stars: 40
Watchers: 7
Forks: 11
Open Issues: 65
Releases: 52

Topics

climate-data climate-science data-structures oceanography python

Created over 4 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Zenodo

`clouddrift`

📦 Distributions

👥 Social

Join the Email Distribution List

📚 Binders and examples

: MOSAiC get started (🧊 sea ice trajectories)
: GDP get started (🌊 ocean drifter trajectories)
: HURDAT2 get started (🌀 cyclone/hurricane trajectories from 1852 - 2022)
HYCOM-OceanTrack: A repository with notebook examples using clouddrift with 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.ragged module.
Common scientific analysis of Lagrangian data, oceanographic or otherwise; for example, see the clouddrift.kinematics, clouddrift.signal, and clouddrift.wavelet modules.
Processing existing Lagrangian datasets into a common data structure and format; for example, see the clouddrift.adapters.mosaic module.
Making cloud-optimized ragged-array datasets easily accessible; for example, see the clouddrift.datasets module.

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. 1. Get the code:

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

Install dependencies and local version of clouddrift: bash pip install .

Conda:

Using conda, you can proceed as follows.

Get the code:

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

Create an environment as specified in the yml file with the required library dependencies: bash conda env create -f environment.yml # creates a new env with the dependencies

2a. Make sure you created the environment by activating it: bash conda activate clouddrift

Finally, install the local version of clouddrift: bash 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.

Owner

Name: CloudDrift
Login: Cloud-Drift
Kind: organization
Location: United States of America

Website: https://cloud-drift.github.io/clouddrift/
Repositories: 4
Profile: https://github.com/Cloud-Drift

A platform for accelerating research with Lagrangian climate data

JOSS Publication

Clouddrift: a Python package to accelerate the use of Lagrangian data for atmospheric, oceanic, and climate sciences

Published

July 23, 2024

DOI

10.21105/joss.06742

Volume 9, Issue 99, Page 6742

Authors

Shane Elipot

Rosenstiel School of Marine, Atmospheric, and Earth Science, University of Miami

Philippe Miron

Florida State University

Milan Curcic

Rosenstiel School of Marine, Atmospheric, and Earth Science, University of Miami, Frost Institute for Data Science and Computing, University of Miami

Kevin Santana

Rosenstiel School of Marine, Atmospheric, and Earth Science, University of Miami

Rick Lumpkin

NOAA Atlantic Oceanographic and Meteorological Laboratory

Editor

Anjali Sandip

GitHub Events

Total

Create event: 3
Release event: 1
Issues event: 31
Watch event: 4
Delete event: 3
Member event: 1
Issue comment event: 114
Push event: 29
Pull request event: 48
Pull request review comment event: 78
Pull request review event: 85
Fork event: 4

Last Year

Create event: 3
Release event: 1
Issues event: 31
Watch event: 4
Delete event: 3
Member event: 1
Issue comment event: 114
Push event: 29
Pull request event: 48
Pull request review comment event: 78
Pull request review event: 85
Fork event: 4

Committers

Last synced: 7 months ago

All Time

Total Commits: 465
Total Committers: 9
Avg Commits per committer: 51.667
Development Distribution Score (DDS): 0.649

Past Year

Commits: 92
Committers: 5
Avg Commits per committer: 18.4
Development Distribution Score (DDS): 0.5

Top Committers

Name	Email	Commits
Philippe Miron	p**n@g**m	163
Milan Curcic	c**o@g**m	104
Shane Elipot	s**t@m**u	81
Kevin Santana	k**1@g**m	49
Kevin	k**7@g**m	46
Philippe Miron	p**n@d**m	13
Vadim BERTRAND	3****r	4
samouertani	s**i@n**v	3
Philippe Miron	p**n@C**l	2

Committer Domains (Top 20 + Academic)

noaa.gov: 1 dtn.com: 1 miami.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 197
Total pull requests: 373
Average time to close issues: about 2 months
Average time to close pull requests: 8 days
Total issue authors: 9
Total pull request authors: 9
Average comments per issue: 1.99
Average comments per pull request: 3.0
Merged pull requests: 304
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 24
Pull requests: 68
Average time to close issues: 17 days
Average time to close pull requests: 7 days
Issue authors: 5
Pull request authors: 6
Average comments per issue: 1.0
Average comments per pull request: 1.79
Merged pull requests: 43
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

selipot (59)
kevinsantana11 (49)
milancurcic (48)
philippemiron (21)
KevinShuman (7)
malmans2 (6)
vadmbertr (4)
miniufo (2)
rcaneill (1)

Pull Request Authors

kevinsantana11 (105)
philippemiron (94)
selipot (74)
milancurcic (61)
KevinShuman (28)
vadmbertr (5)
samouertani (3)
rcaneill (2)
Copilot (1)

Top Labels

Issue Labels

enhancement (70) bug (33) analysis-functions (17) question (15) documentation (13) data-adapters (10) help wanted (3) good first issue (1) tooling (1)

Pull Request Labels

enhancement (80) documentation (33) analysis-functions (23) data-adapters (22) bug (18) help wanted (5) arhicved-label-data-adapters (2)

Packages

Total packages: 3
Total downloads:
- pypi 226 last-month
Total docker downloads: 27

Total dependent packages: 0
(may contain duplicates)
Total dependent repositories: 1
(may contain duplicates)
Total versions: 155
Total maintainers: 3

proxy.golang.org: github.com/Cloud-Drift/clouddrift

Documentation: https://pkg.go.dev/github.com/Cloud-Drift/clouddrift#section-documentation
License: mit
Latest release: v0.45.0
published 9 months ago

Versions: 52
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

proxy.golang.org: github.com/cloud-drift/clouddrift

Documentation: https://pkg.go.dev/github.com/cloud-drift/clouddrift#section-documentation
License: mit
Latest release: v0.45.0
published 9 months ago

Versions: 52
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

pypi.org: clouddrift

Accelerating the use of Lagrangian data for atmospheric, oceanic, and climate sciences

Homepage: https://github.com/Cloud-Drift/clouddrift
Documentation: https://cloud-drift.github.io/clouddrift
License: MIT License
Latest release: 0.45.0
published 9 months ago

Versions: 51
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 226 Last month
Docker Downloads: 27

Rankings

Docker downloads count: 4.2%

Dependent packages count: 7.3%

Downloads: 9.4%

Average: 12.0%

Stargazers count: 12.3%

Forks count: 16.9%

Dependent repos count: 22.1%

Maintainers (3)

milancurcic philippemiron kevinsantana11

Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi

pydata_sphinx_theme *
sphinx *

.github/workflows/black.yml actions

actions/checkout v3 composite
psf/black stable composite

.github/workflows/ci.yml actions

actions/checkout v3 composite
codecov/codecov-action v3 composite
mamba-org/setup-micromamba v1 composite

.github/workflows/docs.yml actions

actions/checkout v3 composite
actions/upload-artifact v3 composite
ad-m/github-push-action master composite
mamba-org/setup-micromamba v1 composite

.github/workflows/pypi.yml actions

actions/checkout v3 composite
actions/download-artifact v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
pypa/gh-action-pypi-publish release/v1 composite

pyproject.toml pypi

aiohttp >=3.8.4
awkward >=2.0.0
fsspec >=2022.3.0
netcdf4 >=1.6.4
numpy >=1.22.4
pandas >=1.3.4
pyarrow >=8.0.0
requests >=2.31.0
scipy >=1.11.2
tqdm >=4.64.0
xarray >=2023.5.0
zarr >=2.14.2

environment.yml conda

Clouddrift

Science Score: 95.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

clouddrift

📦 Distributions

👥 Social

📚 Binders and examples

Using clouddrift

Contributing and scope

Getting started

Install clouddrift

Latest official release:

pip:

Conda:

Development branch:

pip:

Conda:

Installing clouddrift on unsupported platforms

Found an issue or need help?

Owner

JOSS Publication

Clouddrift: a Python package to accelerate the use of Lagrangian data for atmospheric, oceanic, and climate sciences

Authors

Editor

Tags

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

proxy.golang.org: github.com/Cloud-Drift/clouddrift

Rankings

proxy.golang.org: github.com/cloud-drift/clouddrift

Rankings

pypi.org: clouddrift

Rankings

Maintainers (3)

Dependencies

`clouddrift`

Using `clouddrift`

Install `clouddrift`

Installing `clouddrift` on unsupported platforms