API

Main Modules

the_manager

Defines the ParticleTrackingManager class which is the base class for any Lagrangian model to inherit from.

models.opendrift.opendrift

Uses OpenDrift for particle tracking model.

plotting

Some extra plotting code.

Configuration Classes

config_the_manager

Defines TheManagerConfig class for the particle tracking manager.

models.opendrift.config_opendrift

Defines classes OpenDriftConfig, LeewayModelConfig, OceanDriftModelConfig, OpenOilModelConfig, LarvalFishModelConfig, PhytoplanktonModelConfig.

ocean_model_registry

Defines OceanModelConfig with classes stored in ocean_model_registry.

config_ocean_model

Defines OceanModelSimulation and ocean_model_simulation_mapper, a dict with key, value pairs of ocean model name and OceanModelSimulation class.

config_logging

Defines LoggerConfig to set up and manage logs.

config_misc

Defines ParticleTrackingState and SetupOutputFiles.

Plotting and Utilities