From 876091672d94e4ba95f141e145bffc7123882c8f Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Wed, 9 Sep 2026 16:35:23 +0200 Subject: [PATCH 1/4] Update README to v4 --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 72d34ef831..10ea265a98 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,11 @@ [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Parcels-code/parcels/main?labpath=docs%2Fexamples%2Fparcels_tutorial.ipynb) [![LinkedIn](https://custom-icon-badges.demolab.com/badge/LinkedIn-0A66C2?logo=linkedin-white&logoColor=fff)](https://www.linkedin.com/company/parcelscode/) -> [!WARNING] -> This branch contains version 4 of Parcels which is in active development. See `v3-support` to see v3 or the tags to browse stable versions of Parcels. - **Parcels** provides a set of Python classes and methods to create customisable particle tracking simulations using gridded output from (ocean) circulation models. Parcels can be used to track passive and active particulates such as water, plankton, [plastic](http://www.topios.org/) and [fish](https://github.com/Jacketless/IKAMOANA). -![Arctic-SO-medusaParticles](https://github.com/Parcels-code/Parcels/blob/main/docs/_static/homepage.gif?raw=true) +![CopernicusParticles](https://github.com/Parcels-code/Parcels/blob/main/docs/_static/homepage.gif?raw=true) -_Animation of virtual particles carried by ocean surface flow in the global oceans. The particles are advected with [Parcels](http://parcels-code.org/) in data from the [NEMO Ocean Model](https://www.nemo-ocean.eu/)._ +_Animation of virtual particles carried by ocean surface flow in the global oceans. The particles are advected with Parcels in data from the [Copernicus Marine Service](https://marine.copernicus.eu). See [here](https://docs.parcels-code.org/en/stable/user_guide/examples/tutorial_homepage_animation.html) for the script to create this animation yourself._ ### Parcels manuscript and code @@ -39,7 +36,7 @@ _Kehl, C, PD Nooteboom, MLA Kaandorp and E van Sebille (2023) Efficiently simula ### Further information -See [parcels-code.org](http://parcels-code.org/) for further information about [installing](https://docs.parcels-code.org/en/latest/installation.html) and [running](https://docs.parcels-code.org/en/latest/documentation.html) the Parcels code, as well as extended [documentation](https://docs.parcels-code.org/en/latest/reference.html) of the methods and classes. +See [parcels-code.org](http://parcels-code.org/) for further information about [installing](https://docs.parcels-code.org/en/stable/user_guide/getting_started/installation.html) and [running](https://docs.parcels-code.org/en/stable/user_guide/index.html) the Parcels code, as well as extended [API reference](https://docs.parcels-code.org/en/stable/reference/parcels/index.html) of the methods and classes. ### Contributors @@ -47,5 +44,5 @@ See [parcels-code.org](http://parcels-code.org/) for further information about [ -**All contributions are welcome! See the [contributing page](https://docs.parcels-code.org/en/latest/contributing.html) in our documentation to see how to get involved.** +**All contributions are welcome! See the [development page](https://docs.parcels-code.org/en/stable/development/index.html) in our documentation to see how to get involved.** Image made with [contrib.rocks](https://contrib.rocks). From d363cedc1ca10f780581173dfd5d2fa425c8bf24 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Thu, 10 Sep 2026 08:05:55 +0200 Subject: [PATCH 2/4] Add information on v3-support in README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 10ea265a98..dc1642d928 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Parcels-code/parcels/main?labpath=docs%2Fexamples%2Fparcels_tutorial.ipynb) [![LinkedIn](https://custom-icon-badges.demolab.com/badge/LinkedIn-0A66C2?logo=linkedin-white&logoColor=fff)](https://www.linkedin.com/company/parcelscode/) +> This branch contains version 4 of Parcels. Change to `v3-support` to see v3 or the tags to browse stable versions of Parcels. + **Parcels** provides a set of Python classes and methods to create customisable particle tracking simulations using gridded output from (ocean) circulation models. Parcels can be used to track passive and active particulates such as water, plankton, [plastic](http://www.topios.org/) and [fish](https://github.com/Jacketless/IKAMOANA). ![CopernicusParticles](https://github.com/Parcels-code/Parcels/blob/main/docs/_static/homepage.gif?raw=true) From cdc58610dd78030c1f36f4169e866c2bdffb2f95 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Thu, 10 Sep 2026 08:10:44 +0200 Subject: [PATCH 3/4] Updating docs links to latest instead of stable --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dc1642d928..88eae706b5 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ ![CopernicusParticles](https://github.com/Parcels-code/Parcels/blob/main/docs/_static/homepage.gif?raw=true) -_Animation of virtual particles carried by ocean surface flow in the global oceans. The particles are advected with Parcels in data from the [Copernicus Marine Service](https://marine.copernicus.eu). See [here](https://docs.parcels-code.org/en/stable/user_guide/examples/tutorial_homepage_animation.html) for the script to create this animation yourself._ +_Animation of virtual particles carried by ocean surface flow in the global oceans. The particles are advected with Parcels in data from the [Copernicus Marine Service](https://marine.copernicus.eu). See [here](https://docs.parcels-code.org/en/latest/user_guide/examples/tutorial_homepage_animation.html) for the script to create this animation yourself._ ### Parcels manuscript and code @@ -38,7 +38,7 @@ _Kehl, C, PD Nooteboom, MLA Kaandorp and E van Sebille (2023) Efficiently simula ### Further information -See [parcels-code.org](http://parcels-code.org/) for further information about [installing](https://docs.parcels-code.org/en/stable/user_guide/getting_started/installation.html) and [running](https://docs.parcels-code.org/en/stable/user_guide/index.html) the Parcels code, as well as extended [API reference](https://docs.parcels-code.org/en/stable/reference/parcels/index.html) of the methods and classes. +See [parcels-code.org](http://parcels-code.org/) for further information about [installing](https://docs.parcels-code.org/en/latest/user_guide/getting_started/installation.html) and [running](https://docs.parcels-code.org/en/latest/user_guide/index.html) the Parcels code, as well as extended [API reference](https://docs.parcels-code.org/en/latest/reference/parcels/index.html) of the methods and classes. ### Contributors @@ -46,5 +46,5 @@ See [parcels-code.org](http://parcels-code.org/) for further information about [ -**All contributions are welcome! See the [development page](https://docs.parcels-code.org/en/stable/development/index.html) in our documentation to see how to get involved.** +**All contributions are welcome! See the [development page](https://docs.parcels-code.org/en/latest/development/index.html) in our documentation to see how to get involved.** Image made with [contrib.rocks](https://contrib.rocks). From 17410ece9a36ce67d83298de29b0183b75dd62a1 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Thu, 10 Sep 2026 10:48:39 +0200 Subject: [PATCH 4/4] Update README.md Co-authored-by: Nick Hodgskin <36369090+VeckoTheGecko@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 88eae706b5..c05f8bc170 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Parcels-code/parcels/main?labpath=docs%2Fexamples%2Fparcels_tutorial.ipynb) [![LinkedIn](https://custom-icon-badges.demolab.com/badge/LinkedIn-0A66C2?logo=linkedin-white&logoColor=fff)](https://www.linkedin.com/company/parcelscode/) -> This branch contains version 4 of Parcels. Change to `v3-support` to see v3 or the tags to browse stable versions of Parcels. +> This branch contains version 4 of Parcels. Change to `v3-support` to see v3 (which is currently in maintainence mode) or the tags to browse stable versions of Parcels. **Parcels** provides a set of Python classes and methods to create customisable particle tracking simulations using gridded output from (ocean) circulation models. Parcels can be used to track passive and active particulates such as water, plankton, [plastic](http://www.topios.org/) and [fish](https://github.com/Jacketless/IKAMOANA).