The core of our user guide is a series of Jupyter notebooks which document how to implement specific Lagrangian simulations with the flexibility of Parcels. Before diving into these advanced how-to guides (🖥️), we suggest users get started by reading the explanation (📖) of the core concepts and trying the tutorials (🎓). For a description of the specific classes and functions, check out the API reference. To discover other community resources, check out our Community page.
The tutorials written for Parcels v3 are currently being updated for Parcels v4. Shown below are only the notebooks which have been updated.
[Feel free to post a Discussion on GitHub](https://github.com/Parcels-code/Parcels/discussions/categories/ideas) if you feel like v4 needs a specific tutorial that wasn't in v3, or [post an issue](https://github.com/Parcels-code/Parcels/issues/new?template=01_feature.md) if you feel that the notebooks below can be improved!
TODO: Add links to Reference API throughout
**Migrate from v3 to v4** using [this migration guide](v4-migration.md)
:caption: Set up FieldSets
:titlesonly:
examples/explanation_grids.md
examples/tutorial_nemo_curvilinear.ipynb
examples/tutorial_nemo_3D.ipynb
examples/tutorial_croco_3D.ipynb
examples/tutorial_unitconverters.ipynb
:caption: Create ParticleSets
:titlesonly:
examples/tutorial_delaystart.ipynb
:caption: Write Kernels
:titlesonly:
examples/explanation_kernelloop.md
examples/tutorial_sampling.ipynb
examples/tutorial_statuscodes.ipynb
examples/tutorial_gsw_density.ipynb
examples/tutorial_Argofloats.ipynb
examples/tutorial_diffusion.ipynb
examples/tutorial_interaction.ipynb
:caption: Set interpolation method
:titlesonly:
examples/explanation_interpolation.md
examples/tutorial_interpolation.ipynb
:caption: Run a simulation
:name: tutorial-execute
examples/tutorial_numerical_accuracy.ipynb
:caption: Worked examples
:hidden:
:caption: Other
v3 to v4 migration guide <v4-migration>
Example scripts <additional_examples>