seapopym.model package

Submodules

seapopym.model.acidity_model module

The no transport model with acidity-induced mortality.

class seapopym.model.acidity_model.AcidityModel(state: SeapopymState, kernel: Kernel)

Bases: NoTransportModel

A pteropod 1D model that takes into account the mortality due to ocean acidification.

classmethod from_configuration(configuration: AcidityConfiguration) → AcidityModel

Create a model from a configuration.

seapopym.model.base_model module

Implementation of the base class for all models.

class seapopym.model.base_model.BaseModel(state: SeapopymState, kernel: Kernel)

Bases: ABC

The base class for all models.

abstractmethod classmethod from_configuration(configuration: AbstractConfiguration) → BaseModel

Create a model from a configuration.

kernel: Kernel

abstractmethod run() → None

Run the model.

state: SeapopymState

seapopym.model.no_transport_model module

The LMTL model without ADRE equations.

class seapopym.model.no_transport_model.NoTransportLightModel(state: SeapopymState, kernel: Kernel)

Bases: NoTransportModel

Implement the LMTL model without the transport (Advection-Diffusion) and with light kernel.

classmethod from_configuration(configuration: NoTransportConfiguration) → NoTransportLightModel

Create a model from a configuration.

class seapopym.model.no_transport_model.NoTransportModel(state: SeapopymState, kernel: Kernel)

Bases: BaseModel

Implement the LMTL model without the transport (Advection-Diffusion).

property expected_memory_usage: int

The expected memory usage getter.

export_initial_conditions() → xr.Dataset

Export the initial conditions.

classmethod from_configuration(configuration: NoTransportConfiguration) → NoTransportModel

Create a model from a configuration.

run() → None

Run the model. Wrapper of the pre-production, production and post-production processes.

property template: SeapopymState

The template getter.

Module contents