Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

parcels

Can be used to track passive and active particulates such as water, plankton, plastic and fish.
https://github.com/parcels-code/parcels

Category: Hydrosphere
Sub Category: Waves and Currents

Keywords

lagrangian-ocean-modelling ocean-circulation-models particles

Keywords from Contributors

oceanography climate-model climate-science geometry sphinx ocean-modelling sphinx-doc meteorology zarr

Last synced: about 19 hours ago
JSON representation

Repository metadata

Main code for Parcels - a highly customisable Lagrangian simulation framework

README.md

Parcels

Pixi Badge
Anaconda-release
Anaconda-date
Zenodo
EffVer Versioning
Xarray
Ruff
unit-tests
codecov
CII Best Practices
Binder
LinkedIn

[!WARNING]
This branch is v4-dev - version 4 of Parcels which is in active development. See main (or the tags) to browse stable versions of Parcels.

Parcels provides a set of Python classes and methods to create customisable particle tracking simulations using gridded output from (ocean) circulation models. Parcels can be used to track passive and active particulates such as water, plankton, plastic and fish.

Arctic-SO-medusaParticles

Animation of virtual particles carried by ocean surface flow in the global oceans. The particles are advected with Parcels in data from the NEMO Ocean Model.

Parcels manuscript and code

The manuscript detailing the first release of Parcels, version 0.9, has been published in Geoscientific Model Development and can be cited as

Lange, M and E van Sebille (2017) Parcels v0.9: prototyping a Lagrangian Ocean Analysis framework for the petascale age. Geoscientific Model Development, 10, 4175-4186. https://doi.org/10.5194/gmd-2017-167

The manuscript detailing version 2.0 of Parcels is available at Geoscientific Model Development and can be cited as:

Delandmeter, P and E van Sebille (2019) The Parcels v2.0 Lagrangian framework: new field interpolation schemes. Geoscientific Model Development, 12, 3571-3584. https://doi.org/10.5194/gmd-12-3571-2019

The manuscript detailing the performance of Parcels v2.4 is available at Computers & Geosciences and can be cited as:

Kehl, C, PD Nooteboom, MLA Kaandorp and E van Sebille (2023) Efficiently simulating Lagrangian particles in large-scale ocean flows — Data structures and their impact on geophysical applications, Computers and Geosciences, 175, 105322. https://doi.org/10.1016/j.cageo.2023.105322

Further information

See parcels-code.org for further information about installing and running the Parcels code, as well as extended documentation of the methods and classes.

Contributors

All contributions are welcome! See the contributing page in our documentation to see how to get involved.
Image made with contrib.rocks.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Van Sebille"
    given-names: "Erik"
    orcid: "https://orcid.org/0000-0003-2041-0704"
  - family-names: "Kehl"
    given-names: "Christian"
    orcid: "https://orcid.org/0000-0003-4200-1450"
  - family-names: "Lange"
    given-names: "Michael"
    orcid: "https://orcid.org/0000-0002-3232-0127"
  - family-names: "Delandmeter"
    given-names: "Philippe"
    orcid: "https://orcid.org/0000-0003-0100-5834"
  - name: "The Parcels contributors"
    website: "https://github.com/Parcels-code/parcels/graphs/contributors"
title: "Parcels"
version: 3.1.2
doi: 10.5281/zenodo.14845686
date-released: 2025-02-10
url: "https://github.com/Parcels-code/parcels"

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 11 days ago

Total Commits: 6,294
Total Committers: 75
Avg Commits per committer: 83.92
Development Distribution Score (DDS): 0.569

Commits in past year: 1,460
Committers in past year: 16
Avg Commits per committer in past year: 91.25
Development Distribution Score (DDS) in past year: 0.646

Name Email Commits
Erik van Sebille e****e@g****m 2712
Vecko 3****o 872
delandmeter p****r@g****m 651
Christian Kehl c****l@u****l 390
Michael Lange m****e@i****k 329
Joe Schoonover j****e@f****m 222
Roel Brouwer 5****r 162
reint-fischer G****r@M****l 115
Reint 3****r 104
pre-commit-ci[bot] 6****] 102
Daan d****s@o****m 65
Raoul Schram r****m@u****l 61
Willi Rath w****h@g****e 59
pdnooteboom 3****m 42
jacketless j****s@g****m 26
RomanIMMSP 1****P 25
Angus Gibson a****s@a****e 24
Simnator101 s****r@g****m 24
dependabot[bot] 4****] 22
andrew-s28 a****7@g****m 22
Guillaume Maze g****e@i****r 21
reint-fischer G****r@m****e 19
Joel Kronborg j****g@h****m 19
paul p****k@g****m 16
Noam n****t@s****k 14
Michael Denes m****s@g****m 14
Erik van Sebille e****k@i****l 13
JamiePringle j****e@u****u 10
Bas Altena b****a@u****l 10
davidwichmann 3****n 10
and 45 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 6 days ago

Total issues: 22
Total pull requests: 49
Average time to close issues: 17 days
Average time to close pull requests: 4 days
Total issue authors: 6
Total pull request authors: 10
Average comments per issue: 1.32
Average comments per pull request: 1.16
Merged pull request: 21
Bot issues: 0
Bot pull requests: 8

Past year issues: 22
Past year pull requests: 49
Past year average time to close issues: 17 days
Past year average time to close pull requests: 4 days
Past year issue authors: 6
Past year pull request authors: 10
Past year average comments per issue: 1.32
Past year average comments per pull request: 1.16
Past year merged pull request: 21
Past year bot issues: 0
Past year bot pull requests: 8

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/parcels-code/parcels

Top Issue Authors

  • VeckoTheGecko (7)
  • erikvansebille (6)
  • willirath (4)
  • reint-fischer (3)
  • michaeldenes (1)
  • fluidnumerics-joe (1)

Top Pull Request Authors

  • erikvansebille (13)
  • reint-fischer (10)
  • VeckoTheGecko (10)
  • dependabot[bot] (6)
  • pre-commit-ci[bot] (2)
  • nilodna (2)
  • michaeldenes (2)
  • fluidnumerics-joe (2)
  • joseCarlosAndrade (1)
  • andrew-s28 (1)

Top Issue Labels

  • v4 (14)
  • meta (3)
  • api-design (3)
  • hackathon2025 (3)
  • enhancement (3)
  • feature (3)
  • good first issue (2)
  • CI/CD (2)
  • documentation (2)
  • topic/kernels (2)
  • bug (2)
  • topic/interpolators (2)
  • help wanted (2)
  • topic/output-data (1)
  • 🚧BLOCKED🚧 (1)
  • discussion (1)
  • unstructured grids (1)
  • coding/Python (1)
  • oceanography (1)
  • particle-particle interaction (1)
  • needs investigation (1)
  • needs-triage (1)

Top Pull Request Labels

  • dependencies (6)
  • github_actions (6)
  • v4 (2)
  • meta (2)
  • bug (1)
  • topic/kernels (1)
  • api-design (1)

Dependencies

.github/actions/install-parcels/action.yml actions
  • al-cheb/configure-pagefile-action v1.3 composite
  • conda-incubator/setup-miniconda v2.2.0 composite
.github/workflows/integration-tests.yml actions
  • ./.github/actions/install-parcels * composite
  • actions/checkout v3 composite
  • actions/upload-artifact v3.1.2 composite
.github/workflows/linting.yml actions
  • actions/checkout master composite
.github/workflows/pypi-release.yaml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v3 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish v1.5.0 composite
.github/workflows/unit-tests.yml actions
  • ./.github/actions/install-parcels * composite
  • actions/checkout v3 composite
  • actions/upload-artifact v3.1.2 composite
.binder/environment.yml pypi
pyproject.toml pypi

Score: 10.485004604424653