Documentation and Tutorials#
Parcels has several documentation and tutorial Jupyter notebooks and scripts which go through various aspects of Parcels. Static versions of the notebooks are available below via the gallery in the site, with the interactive notebooks being available either completely online at the following Binder link. Following the gallery of notebooks is a list of scripts which provide additional examples to users. You can work with the example notebooks and scripts locally by downloading parcels_tutorials.zip and running with your own Parcels installation.
Warning
In v3.1.0 we updated kernels in the tutorials to use parcels.ParcelsRandom instead of from parcels import ParcelsRandom. Due to our C-conversion code, using parcels.ParcelsRandom only works with v3.1.0+. When browsing/downloading the tutorials, it’s important that you are using the documentation corresponding to the version of Parcels that you have installed. You can find which parcels version you have installed by doing import parcels followed by print(parcels.__version__). If you don’t want to use the latest version of Parcels, you can browse prior versions of the documentation by using the version switcher in the bottom right of this page.
Setting up FieldSets
Creating ParticleSets
Writing kernels to be executed on each particle
Other tutorials
Worked examples
