You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
## plasticparcels
2
2
`plasticparcels` is a python package for simulating the transport and dispersion of plastics in the ocean.
3
3
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: [](https://doi.org/10.21105/joss.07094).
4
+
The tool is based on the [`Parcels`](https://parcels-code.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: [](https://doi.org/10.21105/joss.07094).
@@ -26,26 +26,26 @@ For downloading the wind and wave data, we recommend using the [CDS API](https:/
26
26
27
27
To run most of the examples, you will need to update the data directories in the relevant settings `.json` file.
28
28
29
-
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](https://github.com/OceanParcels/plasticparcels/discussions).
29
+
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](https://github.com/Parcels-code/plasticparcels/discussions).
30
30
31
31
### Community contributions and support
32
32
#### Contributing code
33
-
We welcome contributions to `plasticparcels`, especially example workbooks and analyses for our [public examples page](https://plastic.oceanparcels.org/en/latest/examples.html). To contribute to the project, please submit a [pull request](https://github.com/OceanParcels/plasticparcels/pulls).
33
+
We welcome contributions to `plasticparcels`, especially example workbooks and analyses for our [public examples page](https://plastic.parcels-code.org/en/latest/examples.html). To contribute to the project, please submit a [pull request](https://github.com/Parcels-code/plasticparcels/pulls).
34
34
35
35
#### Requesting features and reporting issues/bugs
36
-
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](https://github.com/OceanParcels/plasticparcels/issues).
36
+
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](https://github.com/Parcels-code/plasticparcels/issues).
37
37
38
38
#### Seeking support?
39
-
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](https://github.com/OceanParcels/plasticparcels/discussions).
39
+
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](https://github.com/Parcels-code/plasticparcels/discussions).
40
40
41
41
42
42
43
43
44
44
### Further information
45
-
For more information and documentation, see the [plasticparcels documentation](https://plastic.oceanparcels.org/).
45
+
For more information and documentation, see the [plasticparcels documentation](https://plastic.parcels-code.org/).
Copy file name to clipboardExpand all lines: docs/examples/example_Croatian_fisheries.ipynb
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,10 @@
5
5
"metadata": {},
6
6
"source": [
7
7
"# Sensitivity of biofouling parameters - Plastic pollution from Croatian fishing vessels\n",
8
-
"In this example, we will use `plasticparcels` to run a basic simulation of microplastic pollution emitted from Croatian registered fishing vessels. We will use the [Open-sea fishing-related plastic emissions dataset](https://plastic.oceanparcels.org/en/latest/initialisationmaps.html#open-sea-fishing-related-plastic-emissions) to release virtual particles in ocean model grid cells, using the 3D velocity fields to advect the particles. We also include the effects of biofouling and Stokes drift on the particles. We will run two simulations, one with the default biofouling parameters, and another where we vary some of the biofouling parameters.\n",
8
+
"In this example, we will use `plasticparcels` to run a basic simulation of microplastic pollution emitted from Croatian registered fishing vessels. We will use the [Open-sea fishing-related plastic emissions dataset](https://plastic.parcels-code.org/en/latest/initialisationmaps.html#open-sea-fishing-related-plastic-emissions) to release virtual particles in ocean model grid cells, using the 3D velocity fields to advect the particles. We also include the effects of biofouling and Stokes drift on the particles. We will run two simulations, one with the default biofouling parameters, and another where we vary some of the biofouling parameters.\n",
9
9
"<div class=\"alert alert-block alert-info\">\n",
10
10
"\n",
11
-
"<b>Note: </b> To run this example you will need to download the hydrodynamic, physical, and biogeochemical model data described [here](https://plastic.oceanparcels.org/en/latest/index.html#required-data).\n",
11
+
"<b>Note: </b> To run this example you will need to download the hydrodynamic, physical, and biogeochemical model data described [here](https://plastic.parcels-code.org/en/latest/index.html#required-data).\n",
12
12
"\n",
13
13
"</div>"
14
14
]
@@ -84,7 +84,7 @@
84
84
"cell_type": "markdown",
85
85
"metadata": {},
86
86
"source": [
87
-
"Next, we define our release settings and plastic particle type. In this example we will use the `fisheries` release type (see [here](https://plastic.oceanparcels.org/en/latest/initialisationmaps.html) for more detail), selecting only release locations related to Croatian fishing vessels. We will simulate the pathways of plastic particles that are 0.1mm in diameter. We will give the plastic particles a denisity of 1028 kg/m<sup>3</sup>."
87
+
"Next, we define our release settings and plastic particle type. In this example we will use the `fisheries` release type (see [here](https://plastic.parcels-code.org/en/latest/initialisationmaps.html) for more detail), selecting only release locations related to Croatian fishing vessels. We will simulate the pathways of plastic particles that are 0.1mm in diameter. We will give the plastic particles a denisity of 1028 kg/m<sup>3</sup>."
88
88
]
89
89
},
90
90
{
@@ -119,7 +119,7 @@
119
119
"metadata": {},
120
120
"source": [
121
121
"## Create a `FieldSet`, `ParticleSet` and `Kernel` list\n",
122
-
"Here we create the necessary `Parcels` objects to run our simulation. The `FieldSet` contains all the hydrodynamic, wind, and wave data required for our simulation. The `ParticleSet` is a set of particles initialised along the Greek coastline, and the `Kernel` list is a list of kernels that will be applied to these particles. A useful overview of these `Parcels` objects can be found [here](https://docs.oceanparcels.org/en/latest/examples/tutorial_parcels_structure.html)."
122
+
"Here we create the necessary `Parcels` objects to run our simulation. The `FieldSet` contains all the hydrodynamic, wind, and wave data required for our simulation. The `ParticleSet` is a set of particles initialised along the Greek coastline, and the `Kernel` list is a list of kernels that will be applied to these particles. A useful overview of these `Parcels` objects can be found [here](https://docs.parcels-code.org/en/latest/examples/tutorial_parcels_structure.html)."
123
123
]
124
124
},
125
125
{
@@ -206,7 +206,7 @@
206
206
"metadata": {},
207
207
"source": [
208
208
"## Plot the trajectories\n",
209
-
"Finally, we produce a simple 'spaghetti' plot of the trajectories to visualise their pathways. To understand how to work with `PlasticParcels` output, please see the `Parcels` tutorial [here](https://docs.oceanparcels.org/en/latest/examples/tutorial_output.html)."
209
+
"Finally, we produce a simple 'spaghetti' plot of the trajectories to visualise their pathways. To understand how to work with `PlasticParcels` output, please see the `Parcels` tutorial [here](https://docs.parcels-code.org/en/latest/examples/tutorial_output.html)."
Copy file name to clipboardExpand all lines: docs/examples/example_Greece_coast.ipynb
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,10 @@
5
5
"metadata": {},
6
6
"source": [
7
7
"# The pathways and fate of existing plastic pollution along Greek coastlines\n",
8
-
"In this example, we will use `plasticparcels` to run a basic simulation of microplastic pollution along the Greek coastline. We will use the [Current global ocean plastic concentrations dataset](https://plastic.oceanparcels.org/en/latest/initialisationmaps.html) to release virtual particles in coastal model grid cells, using the 2D surface velocity fields to advect the particles. We also include the effects of Stokes drift and wind-induced drift on the particles, but neglect any vertical motion (along with any biofouling, or vertical mixing).\n",
8
+
"In this example, we will use `plasticparcels` to run a basic simulation of microplastic pollution along the Greek coastline. We will use the [Current global ocean plastic concentrations dataset](https://plastic.parcels-code.org/en/latest/initialisationmaps.html) to release virtual particles in coastal model grid cells, using the 2D surface velocity fields to advect the particles. We also include the effects of Stokes drift and wind-induced drift on the particles, but neglect any vertical motion (along with any biofouling, or vertical mixing).\n",
9
9
"<div class=\"alert alert-block alert-info\">\n",
10
10
"\n",
11
-
"<b>Note: </b> To run this example you will need to download the hydrodynamic, physical, and biogeochemical model data described [here](https://plastic.oceanparcels.org/en/latest/index.html#required-data).\n",
11
+
"<b>Note: </b> To run this example you will need to download the hydrodynamic, physical, and biogeochemical model data described [here](https://plastic.parcels-code.org/en/latest/index.html#required-data).\n",
12
12
"\n",
13
13
"</div>"
14
14
]
@@ -84,7 +84,7 @@
84
84
"cell_type": "markdown",
85
85
"metadata": {},
86
86
"source": [
87
-
"Next, we define our release settings and plastic particle type. In this example we will use the `global_concentrations` release type, and set `concentration_type = Beach` (see [here](https://plastic.oceanparcels.org/en/latest/initialisationmaps.html) for more detail), selecting only release locations along the Greek coastline. We will simulate the pathways of plastic particles that at 0.1mm, and will apply a wind coefficient of 1%. We give the plastic particles a denisity of 1030 kg/m<sup>3</sup>, however, since this is an ocean-surface only simulation, this parameter will have no impact on our simulation."
87
+
"Next, we define our release settings and plastic particle type. In this example we will use the `global_concentrations` release type, and set `concentration_type = Beach` (see [here](https://plastic.parcels-code.org/en/latest/initialisationmaps.html) for more detail), selecting only release locations along the Greek coastline. We will simulate the pathways of plastic particles that at 0.1mm, and will apply a wind coefficient of 1%. We give the plastic particles a denisity of 1030 kg/m<sup>3</sup>, however, since this is an ocean-surface only simulation, this parameter will have no impact on our simulation."
88
88
]
89
89
},
90
90
{
@@ -120,7 +120,7 @@
120
120
"metadata": {},
121
121
"source": [
122
122
"## Create a `FieldSet`, `ParticleSet` and `Kernel` list\n",
123
-
"Here we create the necessary `Parcels` objects to run our simulation. The `FieldSet` contains all the hydrodynamic, wind, and wave data required for our simulation. The `ParticleSet` is a set of particles initialised along the Greek coastline, and the `Kernel` list is a list of kernels that will be applied to these particles. A useful overview of these `Parcels` objects can be found [here](https://docs.oceanparcels.org/en/latest/examples/tutorial_parcels_structure.html)."
123
+
"Here we create the necessary `Parcels` objects to run our simulation. The `FieldSet` contains all the hydrodynamic, wind, and wave data required for our simulation. The `ParticleSet` is a set of particles initialised along the Greek coastline, and the `Kernel` list is a list of kernels that will be applied to these particles. A useful overview of these `Parcels` objects can be found [here](https://docs.parcels-code.org/en/latest/examples/tutorial_parcels_structure.html)."
124
124
]
125
125
},
126
126
{
@@ -215,7 +215,7 @@
215
215
"metadata": {},
216
216
"source": [
217
217
"## Plot the trajectories\n",
218
-
"Finally, we produce a simple 'spaghetti' plot of the trajectories to visualise their pathways. To understand how to work with `PlasticParcels` output, please see the `Parcels` tutorial [here](https://docs.oceanparcels.org/en/latest/examples/tutorial_output.html)."
218
+
"Finally, we produce a simple 'spaghetti' plot of the trajectories to visualise their pathways. To understand how to work with `PlasticParcels` output, please see the `Parcels` tutorial [here](https://docs.parcels-code.org/en/latest/examples/tutorial_output.html)."
0 commit comments