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.
:caption: Installation instructions
:name: installation
:titlesonly:
getting_started/installation.md
If you have code that uses Parcels v3, you can migrate to Parcels v4 using [🎓 the v3 to v4 migration guide](v4-migration.md)
:caption: Getting Started
:name: getting-started
:titlesonly:
getting_started/tutorial_quickstart.md
getting_started/tutorial_output.ipynb
getting_started/explanation_concepts.md
:caption: Set up FieldSets
:name: setup-fieldsets
:titlesonly:
examples/explanation_grids.md
examples/tutorial_nemo.ipynb
examples/tutorial_croco_3D.ipynb
examples/tutorial_mitgcm.ipynb
examples/tutorial_fesom.ipynb
examples/tutorial_schism.ipynb
examples/tutorial_velocityconversion.ipynb
examples/tutorial_nestedgrids.ipynb
examples/tutorial_manipulating_field_data.ipynb
:caption: Create ParticleSets
:name: create-particlesets
:titlesonly:
examples/tutorial_delaystart.ipynb
:caption: Write Kernels
:name: write-kernels
:titlesonly:
examples/explanation_kernelloop.md
examples/tutorial_sampling.ipynb
examples/tutorial_statuscodes.ipynb
examples/tutorial_write_in_kernel.ipynb
:caption: Set interpolation methods
:name: interpolation-methods
:titlesonly:
examples/explanation_interpolation.md
examples/tutorial_interpolation.ipynb
:caption: Run a simulation
:name: run-simulation
:titlesonly:
examples/tutorial_dt_integrators.ipynb
:caption: Example Kernels
:name: example-kernels
:titlesonly:
examples/tutorial_gsw_density.ipynb
examples/tutorial_Argofloats.ipynb
examples/tutorial_diffusion.ipynb
examples/tutorial_interaction.ipynb
:caption: Other
:name: other
:titlesonly:
🎓 v3 to v4 migration guide <v4-migration>