parcels

Main code for Parcels - a highly customisable Lagrangian simulation framework

https://github.com/oceanparcels/parcels

Science Score: 77.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 11 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    12 of 68 committers (17.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary

Keywords

lagrangian-ocean-modelling ocean-circulation-models particles

Keywords from Contributors

climate-models hydrology reproducibility utrecht-university energy-system-model code-generation geoscience mesh systematic-literature-review systematic-review
Last synced: 6 months ago · JSON representation ·

Repository

Main code for Parcels - a highly customisable Lagrangian simulation framework

Basic Info
Statistics
  • Stars: 329
  • Watchers: 23
  • Forks: 152
  • Open Issues: 127
  • Releases: 39
Topics
lagrangian-ocean-modelling ocean-circulation-models particles
Created over 10 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Parcels

Anaconda-release Anaconda-date Zenodo Code style: Ruff unit-tests codecov CII Best Practices Binder

Parcels (Probably A Really Computationally Efficient Lagrangian Simulator) is a set of Python classes and methods to create customisable particle tracking simulations using 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 oceanparcels.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.

Owner

  • Name: OceanParcels
  • Login: OceanParcels
  • Kind: organization

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/OceanParcels/parcels/graphs/contributors"
title: "Parcels"
version: 3.1.2
doi: 10.5281/zenodo.14845686
date-released: 2025-02-10
url: "https://github.com/OceanParcels/parcels"

GitHub Events

Total
  • Create event: 206
  • Commit comment event: 5
  • Release event: 4
  • Issues event: 171
  • Watch event: 32
  • Delete event: 179
  • Issue comment event: 394
  • Push event: 876
  • Pull request event: 389
  • Pull request review comment event: 400
  • Pull request review event: 487
  • Fork event: 20
Last Year
  • Create event: 206
  • Commit comment event: 5
  • Release event: 4
  • Issues event: 171
  • Watch event: 32
  • Delete event: 179
  • Issue comment event: 394
  • Push event: 876
  • Pull request event: 389
  • Pull request review comment event: 400
  • Pull request review event: 487
  • Fork event: 20

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 4,960
  • Total Committers: 68
  • Avg Commits per committer: 72.941
  • Development Distribution Score (DDS): 0.55
Past Year
  • Commits: 387
  • Committers: 9
  • Avg Commits per committer: 43.0
  • Development Distribution Score (DDS): 0.395
Top Committers
Name Email Commits
Erik van Sebille e****e@g****m 2,234
delandmeter p****r@g****m 651
Vecko 3****o 434
Christian Kehl c****l@u****l 390
Michael Lange m****e@i****k 329
Roel Brouwer 5****r 162
Reint 3****r 95
pre-commit-ci[bot] 6****] 70
Daan d****s@o****m 65
Raoul Schram r****m@u****l 61
Willi Rath w****h@g****e 58
pdnooteboom 3****m 42
jacketless j****s@g****m 26
RomanIMMSP 1****P 25
Simnator101 s****r@g****m 24
Angus Gibson a****s@a****e 24
Guillaume Maze g****e@i****r 21
Joel Kronborg j****g@h****m 19
andrew-s28 a****7@g****m 18
dependabot[bot] 4****] 18
paul p****k@g****m 16
Noam n****t@s****k 14
Erik van Sebille e****k@i****l 13
Michael Denes m****s 12
JamiePringle j****e@u****u 11
davidwichmann 3****n 10
Bas Altena b****a@u****l 10
Thomas-95 t****5@g****m 9
fedeguerr f****i@u****l 8
pierrick-giffard 5****d 7
and 38 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 759
  • Total pull requests: 1,353
  • Average time to close issues: 3 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 171
  • Total pull request authors: 60
  • Average comments per issue: 2.87
  • Average comments per pull request: 0.99
  • Merged pull requests: 1,164
  • Bot issues: 3
  • Bot pull requests: 84
Past Year
  • Issues: 151
  • Pull requests: 419
  • Average time to close issues: 15 days
  • Average time to close pull requests: 5 days
  • Issue authors: 19
  • Pull request authors: 10
  • Average comments per issue: 1.03
  • Average comments per pull request: 0.84
  • Merged pull requests: 327
  • Bot issues: 2
  • Bot pull requests: 58
Top Authors
Issue Authors
  • erikvansebille (157)
  • VeckoTheGecko (120)
  • fluidnumerics-joe (24)
  • delandmeterp (22)
  • CKehl (19)
  • willirath (18)
  • Jacketless (13)
  • JamiePringle (12)
  • nvogtvincent (12)
  • pierrick-giffard (10)
  • wongchieh (10)
  • daanreijnders (9)
  • angus-g (8)
  • michaeldenes (8)
  • claudiofgcardoso (8)
Pull Request Authors
  • erikvansebille (610)
  • VeckoTheGecko (260)
  • delandmeterp (111)
  • pre-commit-ci[bot] (47)
  • mlange05 (37)
  • dependabot[bot] (37)
  • CKehl (33)
  • fluidnumerics-joe (32)
  • willirath (22)
  • Jacketless (17)
  • angus-g (16)
  • reint-fischer (13)
  • dicaearchus (10)
  • andrew-s28 (9)
  • daanreijnders (7)
Top Labels
Issue Labels
bug (60) enhancement (51) v4 (45) documentation (22) coding/Python (22) discussion (22) question (15) help wanted (13) good first issue (13) feature (10) summer refactoring (10) particle-particle interaction (8) cleanup (8) coding/C (5) needs investigation (4) v3 (4) testing (3) api-design (2) input-data (2) refactor (2) 🚧BLOCKED🚧 (2) unstructured grids (2) oceanography (2) dependencies (1)
Pull Request Labels
v4 (54) dependencies (37) enhancement (14) bug (11) github_actions (6) wontfix (5) particle-particle interaction (4) help wanted (3) discussion (3) documentation (3) feature (2) coding/Python (2) coding/C (1) run-benchmark (1) v3 (1) summer refactoring (1) testing (1)

Packages

  • Total packages: 4
  • Total downloads:
    • pypi 697 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 21
    (may contain duplicates)
  • Total versions: 110
  • Total maintainers: 3
proxy.golang.org: github.com/oceanparcels/parcels
  • Versions: 35
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 1.6%
Average: 4.1%
Dependent packages count: 6.5%
Last synced: 6 months ago
proxy.golang.org: github.com/OceanParcels/parcels
  • Versions: 35
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago
pypi.org: parcels

Framework for Lagrangian tracking of virtual ocean particles in the petascale age.

  • Documentation: https://parcels.readthedocs.io/
  • License: The MIT License (MIT) Copyright (c) 2019, OceanParcels team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 3.1.4
    published 7 months ago
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 5
  • Downloads: 697 Last month
  • Docker Downloads: 0
Rankings
Docker downloads count: 2.0%
Dependent repos count: 6.6%
Average: 8.4%
Dependent packages count: 10.1%
Downloads: 14.8%
Last synced: 6 months ago
conda-forge.org: parcels

Parcels (Probably A Really Computationally Efficient Lagrangian Simulator) is a set of Python classes and methods to create customisable particle tracking simulations using output from Ocean Circulation models. Parcels can be used to track passive and active particulates such as water, nutrients, plankton, plastic and fish.

  • Versions: 22
  • Dependent Packages: 0
  • Dependent Repositories: 16
Rankings
Dependent repos count: 8.8%
Forks count: 17.1%
Stargazers count: 24.3%
Average: 25.4%
Dependent packages count: 51.5%
Last synced: 6 months ago

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