Skip to content

Commit 7b0b879

Browse files
committed
Update links from oceanparcels.org to parcels-code.org
Also update authors to 'PlasticParcels developers'
1 parent 8e42265 commit 7b0b879

13 files changed

Lines changed: 34 additions & 34 deletions

README.md

Lines changed: 3 additions & 3 deletions
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. 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).
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: [![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

@@ -30,7 +30,7 @@ Just like the `parcels` framework, `plasticparcels` can be adapted to use other
3030

3131
### Community contributions and support
3232
#### 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/OceanParcels/plasticparcels/pulls).
3434

3535
#### Requesting features and reporting issues/bugs
3636
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).
@@ -42,7 +42,7 @@ If you would like support using `plasticparcels`, or are have any questions abou
4242

4343

4444
### 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/).
4646

4747
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07094/status.svg)](https://doi.org/10.21105/joss.07094)
4848
[![unit-tests](https://github.com/OceanParcels/plasticparcels/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/OceanParcels/plasticparcels/actions/workflows/unit_tests.yml)

docs/examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Examples
22

3-
Up-to-date documentation on the `plasticparcels` examples can be found [here](https://plastic.oceanparcels.org/en/latest/examples.html).
3+
Up-to-date documentation on the `plasticparcels` examples can be found [here](https://plastic.parcels-code.org/en/latest/examples.html).

docs/examples/example_Croatian_fisheries.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
"metadata": {},
66
"source": [
77
"# 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",
99
"<div class=\"alert alert-block alert-info\">\n",
1010
"\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",
1212
"\n",
1313
"</div>"
1414
]
@@ -84,7 +84,7 @@
8484
"cell_type": "markdown",
8585
"metadata": {},
8686
"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>."
8888
]
8989
},
9090
{
@@ -119,7 +119,7 @@
119119
"metadata": {},
120120
"source": [
121121
"## 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)."
123123
]
124124
},
125125
{
@@ -206,7 +206,7 @@
206206
"metadata": {},
207207
"source": [
208208
"## 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)."
210210
]
211211
},
212212
{

docs/examples/example_Greece_coast.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
"metadata": {},
66
"source": [
77
"# 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",
99
"<div class=\"alert alert-block alert-info\">\n",
1010
"\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",
1212
"\n",
1313
"</div>"
1414
]
@@ -84,7 +84,7 @@
8484
"cell_type": "markdown",
8585
"metadata": {},
8686
"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."
8888
]
8989
},
9090
{
@@ -120,7 +120,7 @@
120120
"metadata": {},
121121
"source": [
122122
"## 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)."
124124
]
125125
},
126126
{
@@ -215,7 +215,7 @@
215215
"metadata": {},
216216
"source": [
217217
"## 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)."
219219
]
220220
},
221221
{

docs/examples/example_Italy_coast.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
"metadata": {},
66
"source": [
77
"# The pathways and fate of Italian coastal plastic pollution\n",
8-
"In this example, we will use `plasticparcels` to run a basic simulation of microplastic pollution along the Italian coastline. We will use the [Coastal mismanaged plastic waste emissions 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 Italian coastline. We will use the [Coastal mismanaged plastic waste emissions 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",
99
"<div class=\"alert alert-block alert-info\">\n",
1010
"\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",
1212
"\n",
1313
"</div>"
1414
]
@@ -88,7 +88,7 @@
8888
"cell_type": "markdown",
8989
"metadata": {},
9090
"source": [
91-
"Next, we define our release settings and plastic particle type. In this example we will use the `coastal` release type (see [here](https://plastic.oceanparcels.org/en/latest/initialisationmaps.html) for more detail), selecting only release locations along the Italian 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."
91+
"Next, we define our release settings and plastic particle type. In this example we will use the `coastal` release type (see [here](https://plastic.parcels-code.org/en/latest/initialisationmaps.html) for more detail), selecting only release locations along the Italian 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."
9292
]
9393
},
9494
{
@@ -123,7 +123,7 @@
123123
"metadata": {},
124124
"source": [
125125
"## Create a `FieldSet`, `ParticleSet` and `Kernel` list\n",
126-
"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 Italian 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)."
126+
"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 Italian 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)."
127127
]
128128
},
129129
{
@@ -210,7 +210,7 @@
210210
"metadata": {},
211211
"source": [
212212
"## Plot the trajectories\n",
213-
"Finally, we produce a simple 'spaghetti' plot and and a concentration map 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)."
213+
"Finally, we produce a simple 'spaghetti' plot and and a concentration map 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)."
214214
]
215215
},
216216
{

docs/examples/example_add_your_own_kernel.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"In this example, we will show how to turn on/off existing behaviour kernels, and how to create and include your own behaviour kernel to use in `plasticparcels` simulations. We will start by importing some necessary packages.\n",
99
"<div class=\"alert alert-block alert-info\">\n",
1010
"\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",
1212
"\n",
1313
"</div>"
1414
]
@@ -193,7 +193,7 @@
193193
"metadata": {},
194194
"source": [
195195
"## Create a `Kernel` list\n",
196-
"The virtual plastic particles will experience any behaviour that we apply to it. `plasticparcels` contains a few prebuilt behaviours (see [here](https://plastic.oceanparcels.org/en/latest/physicskernels.html) for more details). To use these behaviours, we must include a list of `Kernel` objects. Each `Kernel` describes some physics behaviour to be applied. To include the prebuilt kernels, we use the `constructors.create_kernel()` method."
196+
"The virtual plastic particles will experience any behaviour that we apply to it. `plasticparcels` contains a few prebuilt behaviours (see [here](https://plastic.parcels-code.org/en/latest/physicskernels.html) for more details). To use these behaviours, we must include a list of `Kernel` objects. Each `Kernel` describes some physics behaviour to be applied. To include the prebuilt kernels, we use the `constructors.create_kernel()` method."
197197
]
198198
},
199199
{
@@ -330,7 +330,7 @@
330330
"metadata": {},
331331
"source": [
332332
"## Implementing your own kernel\n",
333-
"In the case you want to include your own kernel or modify an existing kernel, you simply need to define your kernel and include it in the list of kernels. More details on how this works can be found [here](https://docs.oceanparcels.org/en/latest/examples/tutorial_kernelloop.html).\n",
333+
"In the case you want to include your own kernel or modify an existing kernel, you simply need to define your kernel and include it in the list of kernels. More details on how this works can be found [here](https://docs.parcels-code.org/en/latest/examples/tutorial_kernelloop.html).\n",
334334
"\n",
335335
"Note: You must include the kernel before the error checking kernels, which are currently the last five kernels."
336336
]

0 commit comments

Comments
 (0)