Skip to content

Commit b888f78

Browse files
authored
Merge pull request #63 from OceanParcels/michaeldenes-patch-1
Adding JOSS article to readme
2 parents aaf0871 + fa2d77f commit b888f78

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## plasticparcels
22
`plasticparcels` is a python package for simulating the transport and dispersion of plastics in the ocean.
33

4-
The tool is based on the [`Parcels`](https://oceanparcels.org/) computational Lagrangian ocean analysis framework ([@Lange2017](http://dx.doi.org/10.5194/gmd-10-4175-2017) and [@Delandmeter2019](http://dx.doi.org/10.5194/gmd-12-3571-2019)), providing a modular and customisable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties.
4+
The tool is based on the [`Parcels`](https://oceanparcels.org/) computational Lagrangian ocean analysis framework ([@Lange2017](http://dx.doi.org/10.5194/gmd-10-4175-2017) and [@Delandmeter2019](http://dx.doi.org/10.5194/gmd-12-3571-2019)), 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](https://joss.theoj.org/papers/10.21105/joss.07094/status.svg)](https://doi.org/10.21105/joss.07094).
55

66
![plasticparcels](docs/_static/plasticparcelslogo.png)
77

@@ -44,6 +44,7 @@ If you would like support using `plasticparcels`, or are have any questions abou
4444
### Further information
4545
For more information and documentation, see the [plasticparcels documentation](https://plastic.oceanparcels.org/).
4646

47+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07094/status.svg)](https://doi.org/10.21105/joss.07094)
4748
[![unit-tests](https://github.com/OceanParcels/plasticparcels/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/OceanParcels/plasticparcels/actions/workflows/unit_tests.yml)
4849
[![Anaconda-release](https://anaconda.org/conda-forge/plasticparcels/badges/version.svg)](https://anaconda.org/conda-forge/plasticparcels/)
4950
[![Anaconda-date](https://anaconda.org/conda-forge/plasticparcels/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/plasticparcels/)

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Welcome to the documentation of ``plasticparcels``.
1010

1111
``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, providing a modular and customisable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties.
1212

13+
The manuscript detailing the first release of ``plasticparcels``, version 0.3.1, has been published in `Journal of Open Source Software (JOSS) <https://doi.org/10.21105/joss.07094>`.
1314

1415
Installation
1516
^^^^^^^^^^^^

0 commit comments

Comments
 (0)