Data

Tools

Indexes

Applications

Experiments

Open Source Science

plasticparcels

plasticparcels: A python package for marine plastic dispersal simulations and parameterisation development using parcels - Published in JOSS (2024)

https://github.com/oceanparcels/plasticparcels

Science Score: 93.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 16 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Political Science Social Sciences - 90% confidence
Engineering Computer Science - 80% confidence
Last synced: 4 months ago · JSON representation

Repository

Repository for PlasticParcels tool

Basic Info
  • Host: GitHub
  • Owner: OceanParcels
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 40.3 MB
Statistics
  • Stars: 11
  • Watchers: 4
  • Forks: 6
  • Open Issues: 7
  • Releases: 5
Created about 2 years ago · Last pushed 4 months ago
Metadata Files
Readme License

README.md

plasticparcels

plasticparcels is a python package for simulating the transport and dispersion of plastics in the ocean.

The tool is based on the Parcels computational Lagrangian ocean analysis framework (@Lange2017 and @Delandmeter2019), providing a modular and customisable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties. A peer reviewed paper describing plasticparcels can be found here: DOI.

plasticparcels

Installation

plasticparcels can be installed using conda from the conda-forge channel with the following command:

bash conda install conda-forge::plasticparcels

Required data

plasticparcels has been developed for use with data from the Copernicus Marine Service, and requires the following data to run:

For downloading the wind and wave data, we recommend using the CDS API.

To run most of the examples, you will need to update the data directories in the relevant settings .json file.

Just like the parcels framework, plasticparcels can be adapted to use other hydrodynamic, biogeochemical, wave, and atmospheric models. If you require assistance, please contact us through the plasticparcels discussions page.

Community contributions and support

Contributing code

We welcome contributions to plasticparcels, especially example workbooks and analyses for our public examples page. To contribute to the project, please submit a pull request.

Requesting features and reporting issues/bugs

If you want to request a new feature, or if you find an issue or bug in the code, please open an issue in the plasticparcels issue tracker.

Seeking support?

If you would like support using plasticparcels, or are have any questions about your plasticparcels simulations, please start a discussion in the plasticparcels discussion page.

Further information

For more information and documentation, see the plasticparcels documentation.

DOI unit-tests Anaconda-release Anaconda-date Zenodo

Owner

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

JOSS Publication

plasticparcels: A python package for marine plastic dispersal simulations and parameterisation development using parcels
Published
October 23, 2024
DOI
Volume 9, Issue 102, Page 7094
Authors
Michael C. Denes ORCID
Institute for Marine and Atmospheric Research, Utrecht University, the Netherlands
Erik van Sebille ORCID
Institute for Marine and Atmospheric Research, Utrecht University, the Netherlands
Editor
Anjali Sandip ORCID
Tags
Plastic dispersal simulations Lagrangian oceanography Fluid dynamics
View PDF Review Thread Software Archive

GitHub Events

Total
  • Issues event: 4
  • Watch event: 8
  • Delete event: 4
  • Issue comment event: 13
  • Push event: 49
  • Pull request review event: 1
  • Pull request event: 10
  • Fork event: 3
  • Create event: 5
Last Year
  • Issues event: 4
  • Watch event: 8
  • Delete event: 4
  • Issue comment event: 13
  • Push event: 49
  • Pull request review event: 1
  • Pull request event: 10
  • Fork event: 3
  • Create event: 5

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 343
  • Total Committers: 4
  • Avg Commits per committer: 85.75
  • Development Distribution Score (DDS): 0.289
Past Year
  • Commits: 104
  • Committers: 4
  • Avg Commits per committer: 26.0
  • Development Distribution Score (DDS): 0.221
Top Committers
Name Email Commits
michaeldenes m****s@g****m 244
Erik van Sebille e****e@g****m 77
pre-commit-ci[bot] 6****] 12
Vecko 3****o 10

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 15
  • Total pull requests: 74
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 6
  • Total pull request authors: 5
  • Average comments per issue: 1.13
  • Average comments per pull request: 0.96
  • Merged pull requests: 64
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 4
  • Pull requests: 18
  • Average time to close issues: 16 days
  • Average time to close pull requests: 8 days
  • Issue authors: 4
  • Pull request authors: 5
  • Average comments per issue: 2.0
  • Average comments per pull request: 1.44
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 5
View more stats
Top Authors
Issue Authors
  • erikvansebille (8)
  • michaeldenes (3)
  • xgfd (1)
  • philippemiron (1)
  • martoconnh (1)
  • zhenwu0728 (1)
Pull Request Authors
  • michaeldenes (56)
  • erikvansebille (22)
  • pre-commit-ci[bot] (9)
  • VeckoTheGecko (4)
  • GaiaBuccino (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 8
proxy.golang.org: github.com/OceanParcels/plasticparcels
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
proxy.golang.org: github.com/oceanparcels/plasticparcels
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago

Dependencies

environment.yml conda
  • coverage
  • geopandas
  • parcels >=3.0.2
  • pytest
  • shapely
.github/workflows/draft-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/actions/install-plasticparcels/action.yml actions
  • mamba-org/setup-micromamba v1 composite
.github/workflows/linting.yml actions
  • actions/checkout master composite
.github/workflows/unit_tests.yml actions
  • ./.github/actions/install-plasticparcels * composite
  • actions/checkout v3 composite
pyproject.toml pypi
  • parcels >= 3.0.2, < 4
  • pytest *