User guide#

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.

Installation#

Installation instructions

Note

If you have code that uses Parcels v3, you can migrate to Parcels v4 using 🎓 the v3 to v4 migration guide

Getting started#

Converting model data to FieldSets#

Work with FieldSets#

Create ParticleSets#

Create ParticleSets

Write Kernels#

Set interpolation methods#

Run a simulation#

Example Kernels#

Other#