MoaceanParcels

Contents:

  • Installation
  • Kernels
    • How to Add a Kernel to moacean_parcels.kernels
    • MOAD Kernel Functions and Particle Classes
    • Kernel Example Notebooks
  • MoaceanParcels Package Development
Index Module Index
MoaceanParcels
  • Kernels
  • View page source

Kernels

This section provides

Contents:

  • How to Add a Kernel to moacean_parcels.kernels
    • Kernel Modules
      • Conventions
      • Copyright Notice
      • Kernel Function Signature
      • Particle Class Sub-classing
      • Kernel Function Docstrings
      • Particle Class Documentation
    • Kernel Function and Particle Class Registration
    • Kernel Function and Particle Class Auto-Documentation
    • Kernel Example Notebooks
  • MOAD Kernel Functions and Particle Classes
    • Particle Behaviour Kernels and Particle Classes
      • Stokes_drift()
        • Stokes_drift()
    • Recovery Kernels
      • DeleteParticle()
        • DeleteParticle()
  • Kernel Example Notebooks
    • Particle Behaviour Kernel Example Notebooks
      • Example Use of the Stokes_drift Kernel
    • Recovery Kernel Example Notebooks
      • Example Use of the DeleteParticle Kernel
Previous Next

© Copyright 2021 – present, The UBC EOAS MOAD Group and The University of British Columbia. Last updated on Jun 19, 2026.

Built with Sphinx using a theme provided by Read the Docs.