MoaceanParcels Documentation

This is the documentation for the MoaceanParcels Python package. MoaceanParcels contains shared kernels and other code for OceanParcels that has been developed by the UBC-MOAD group.

Contents:

• Installation
  • Details
    • Getting the Code
    • Create a conda Environment
    • Activate Environment and Install the Package
• Kernels
  • 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
• MoaceanParcels Package Development
  • Python Versions
  • Getting the Code
  • Development Environment
  • Coding Style
  • Building the Documentation
    • Link Checking the Documentation
  • Running the Unit Tests
  • Version Control Repository
  • Issue Tracker
  • License

Indices

• Index

• Module Index

License

The code and documentation of the MOAD OceanParcels kernels and utilities project are copyright 2021 – present by UBC EOAS MOAD Group and The University of British Columbia.

They are licensed under the Apache License, Version 2.0. https://www.apache.org/licenses/LICENSE-2.0 Please see the LICENSE file for details of the license.