Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@
[![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.
> 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).

![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/latest/user_guide/examples/tutorial_homepage_animation.html) for the script to create this animation yourself._

### Parcels manuscript and code

Expand All @@ -39,13 +38,13 @@ _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/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

<a href="https://github.com/parcels-code/parcels/graphs/contributors">
<img src="https://contrib.rocks/image?repo=parcels-code/parcels" />
</a>

**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/latest/development/index.html) in our documentation to see how to get involved.**
Image made with [contrib.rocks](https://contrib.rocks).