Skip to content

Commit a2bac2d

Browse files
committed
small sentence changes to README
1 parent 0f9f8d2 commit a2bac2d

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# PlasticParcels
2-
`PlasticParcels` is a python package for simulating the transport and dispersion of plastics in the ocean. The tool is based on `v3.0.2` of the `Parcels` computational Lagrangian ocean analysis framework [@Lange2017,@Delandmeter2019], providing a modular and customizable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties.
2+
`PlasticParcels` is a python package for simulating the transport and dispersion of plastics in the ocean. The tool is based on `v3.0.2` of the [`Parcels`](https://oceanparcels.org/) computational Lagrangian ocean analysis framework [@Lange2017](http://dx.doi.org/10.5194/gmd-10-4175-2017)[@Delandmeter2019](http://dx.doi.org/10.5194/gmd-12-3571-2019), providing a modular and customizable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties.
33

44
# Table of contents
55
0. [Description of Software](#description)
@@ -22,7 +22,7 @@ An open-source article describing `PlasticParcels` can be found here **link to a
2222

2323
The current version supports nano- and microplastic behaviour, with support for macroplastics planned in the near-future. It has been designed for use with the Copernicus Marine Service platform [@CMEMS](https://marine.copernicus.eu/), providing new plastic modelling capabilities as part of the NECCTON project. `PlasticParcels` is easily adapted to run on local machines and high-performance computing (HPC) architecture with various hydrodynamic, biogeochemical, and other model fields as inputs. A future goal is to embed `PlasticParcels` within a cloud platform to allow for even more rapid prototyping, development, and simulations.
2424

25-
Below we detail the specific physics kernels implemented, as well as describe how the particle initialisation maps are generated.
25+
Below we provide instructions to install `PlasticParcels`, we detail the specific physics kernels implemented in the tool, and we describe how the particle initialisation maps are generated.
2626

2727
## Installation
2828
**(Is this necessary? Or can be relegated to the github readme?)**
@@ -50,7 +50,7 @@ Ensure that you have updated `settings.txt` with the required directories and fi
5050

5151
## Physics kernels <a name="physicskernels"></a>
5252

53-
The `Parcels` Lagrangian framework is a tool for advecting virtual particles that are assumed to be spherical in shape. It works by numerically integrating the velocity fields from a hydrodynamic model while including any additional \textit{behaviour} of the particle. Mathematically, particle trajectories are computed by solving the following equation:
53+
The [`Parcels`](https://oceanparcels.org/) Lagrangian framework is a tool for advecting virtual particles that are assumed to be spherical in shape. It works by numerically integrating the velocity fields from a hydrodynamic model while including any additional \textit{behaviour} of the particle. Mathematically, particle trajectories are computed by solving the following equation:
5454

5555
```math
5656
\mathbf{x}(t) = \mathbf{x}(0) + \int_{0}^{t} \mathbf{v}(\mathbf{x}(s), s) + \mathbf{B}(\mathbf{x}(s),s) \text{d}s,
@@ -64,7 +64,7 @@ Numerically, we solve the above equation using a time-stepping approach, where w
6464
\frac{\text{d}\mathbf{x}(t)}{\text{d}t} = \mathbf{v}(\mathbf{x}(t), t) + \mathbf{B}(\mathbf{x}(t), t),
6565
```
6666

67-
and updating the particle position at each timestep. For simplicity, by default we use the fourth-order Runge-Kutta scheme of `Parcels` to solve the advection of the particle from the hydrodynamic model velocity field $`\mathbf{v}`$, and an Euler-forward scheme for all other additional behaviours realised in $`\mathbf{B}`$.
67+
and updating the particle position at each timestep. For simplicity, by default we use the fourth-order Runge-Kutta scheme of [`Parcels`](https://oceanparcels.org/) to solve the advection of the particle from the hydrodynamic model velocity field $`\mathbf{v}`$, and an Euler-forward scheme for all other additional behaviours realised in $`\mathbf{B}`$.
6868

6969

7070
### Stokes Drift <a name="stokes"></a>
@@ -152,11 +152,11 @@ To generate a particle initialisation map of plastic pollution that enters the o
152152
d. For each identified coastal model grid-cell, identify the maximum population density from the GPW data within a specified distance $\phi$ (in degrees) north/south or east/west from the coastal model grid-cell center.
153153
e. Create an array with the coastal model grid-cell and it's associated area, the country name, continent name, region name, and subregion name from the shapefile, and the identified population density.
154154
5. Combine all entries generated in Step 4) a) into one array.
155-
6. Load the global mismanaged plastic waste data [@Jambeck2015](http://dx.doi.org/10.1126/science.1260352), and join it to the array generated in Step 5), by 'left joining' on country name$^*$. Create an additional column 'MPW_cell', mismanaged plastic waste across the grid cell by multiplying the mismanaged plastic waste per kilogram per day with the population density and the grid-cell area.
155+
6. Load the global mismanaged plastic waste data [@Jambeck2015](http://dx.doi.org/10.1126/science.1260352), and join it to the array generated in Step 5), by 'left joining' on country name$`^*`$. Create an additional column 'MPW_cell', mismanaged plastic waste across the grid cell by multiplying the mismanaged plastic waste per kilogram per day with the population density and the grid-cell area.
156156
7. Save the data into a `.csv` file, to be read and processed by `PlasticParcels`.
157157

158158

159-
$^*$We pre-process the country names in the [@Jambeck2015](http://dx.doi.org/10.1126/science.1260352) data to account for small differences in the naming conventions of each country. Here, we use $r=50$ km, and $\phi$ is chosen as the model grid width in degrees. A sample plot of the initialisation map is shown in Figure X **add link**.
159+
$`^*`$We pre-process the country names in the [@Jambeck2015](http://dx.doi.org/10.1126/science.1260352) data to account for small differences in the naming conventions of each country. Here, we use $`r=50`$ km, and $`\phi`$ is chosen as the model grid width in degrees. A sample plot of the initialisation map is shown in Figure X **add link**.
160160

161161
### Riverine mismanaged plastic waste emissions <a name="riverrelease"></a>
162162
To generate a particle initialisation map of plastic pollution that enters the ocean from river sources, we use a global riverine input dataset [@Meijer2021](http://dx.doi.org/10.1126/sciadv.aaz5803). This dataset is provided in the form of a shapefile, providing a location (latitude and longitude) and amount of plastic emissions (in units of tonnes per year). The algorithm is as follows:
@@ -199,7 +199,7 @@ To generate a particle initialisation map of plastic pollution emitted into the
199199

200200

201201
TODO:
202-
1. change references to DOI Links
202+
1. ~~change references to DOI Links~~ -- add links to non-published papers
203203
2. Update algorithms to be clearer
204204
3. Include additional kernels explanations
205205
4. Include release dataset explanations that are missing

0 commit comments

Comments
 (0)