Plugins for LADiM

This repository contains plugins for the Lagrangian Advection and Diffusion Model (LADiM), which is the particle tracking software used at the Institute of Marine Research (IMR). (https://github.com/bjornaa/ladim)

Documentation and examples are provided for each model.

List of available plugins

Name	Description
chemicals	Passive tracer
egg	Buoyant fish eggs
lunar_eel	Glass eels with lunar compass
nk800met	Module for utilizing forcing data from the met.no thredds server
release	General module for creating release files
salmon_lice	Salmon lice larvae
sandeel	Sand eel larvae
sedimentation	Sinking particles
utils	General utility functions for IBMs

Installation

Install using the following command

pip install ladim_plugins

The installation can be tested with the command

pytest -Wignore --pyargs ladim_plugins

This command will run ladim on each of the plugins, using the sample ladim.yaml and particle.rls files found in the subpackage folders. The tests succeed if ladim is present on the system, ladim_plugins is installed correctly, and the output from the ladim runs matches exactly with the out.nc files found in the subpackage folders.

Usage

Copy ladim.yaml and particle.rls from the IBM subpackage of interest into the working directory.
Make desired changes to the yaml and rls files. More detailed instructions are found in the README.md file within the subpackage.
Run ladim and the output is written to out.nc.

Contribute

To add new plugins, contact the maintainer of the ladim_plugins repository. A properly structured IBM subpackage has the following ingredients:

A file __init__.py containing the statement from .ibm import IBM
The IBM module itself, named ibm.py
A README.md file containing instructions for use
A simple test example. This includes a ladim.yaml configuration file, a particles.rls release file, a forcing.nc forcing file (may be copied from another subpackage), and a ladim output file named out.nc.
Optionally a test example for generating release files. This includes a release.yaml configuration file and an output release file named out.rls.
Optionally additional automated test modules, named test_*.py

An ideal test example should be quick to run and easy to analyze, but still be complicated enough to demonstrate most capabilities of the IBM model. To achieve this, it may be a good idea to use only a few time steps and a few particles at selected positions. In some cases it may also be necessary to specify somewhat unrealistic particle parameters to demonstrate certain features.

The test is run using the command pytest -Wignore --pyargs ladim_plugins. The test succeeds if ladim is able to run the examples, and the output matches the contents of out.nc / out.rls.

Metadata

Release files for ladim-plugins 2.10.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ladim-plugins 2.10.7
File	Size	Uploaded
ladim_plugins-2.10.7.tar.gz	23.5 MB	Sep 28, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ladim-plugins 2.10.7
File	Interpreter	ABI	Platform	Reset
ladim_plugins-2.10.7-py3-none-any.whl 23.6 MB Sep 28, 2026	Python 3	none	any	Details

Total release size: 47.1 MB

Release files / ladim_plugins-2.10.7.tar.gz

Download URL	ladim_plugins-2.10.7.tar.gz
Size	23.5 MB
Tags	Source
SHA-256 checksum How to use checksums	`ac98d055229a1a8b24833ac3134fa2ec5ba6b670e94020253fac3a946fe4612c`
BLAKE2b-256 checksum How to use checksums	`f807e29944a9f79c318de5910562e41dc9d1f9d5f1279c32a504384cf2e435fe`
Upload date	Sep 28, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pnsaevik/ladim_plugins
Publishing commit: github.com/pnsaevik/ladim_plugins/tree/6f5168492c0cd87d5eeab0821edc143b365e07f0

Workflow

Publishing configuration: github.com/pnsaevik/ladim_plugins/blob/6f5168492c0cd87d5eeab0821edc143b365e07f0/.github/workflows/pypi.yml
Publishing logs: github.com/pnsaevik/ladim_plugins/actions/runs/36406750915/attempts/1

Artifact

Subject: ladim_plugins-2.10.7.tar.gz
SHA-256 checksum: ac98d055229a1a8b24833ac3134fa2ec5ba6b670e94020253fac3a946fe4612c Verifying attestations

Release files / ladim_plugins-2.10.7-py3-none-any.whl

Download URL	ladim_plugins-2.10.7-py3-none-any.whl
Size	23.6 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`beab5392baf2d65843c6847da071b2ff327dad9e6f628881c42c502ad692c841`
BLAKE2b-256 checksum How to use checksums	`e1e7861576c7e19df4d8407b5e4352cad4dc7ac72948ed7384aa2afecba037f7`
Upload date	Sep 28, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pnsaevik/ladim_plugins
Publishing commit: github.com/pnsaevik/ladim_plugins/tree/6f5168492c0cd87d5eeab0821edc143b365e07f0

Workflow

Publishing configuration: github.com/pnsaevik/ladim_plugins/blob/6f5168492c0cd87d5eeab0821edc143b365e07f0/.github/workflows/pypi.yml
Publishing logs: github.com/pnsaevik/ladim_plugins/actions/runs/36406750915/attempts/1

Artifact

Subject: ladim_plugins-2.10.7-py3-none-any.whl
SHA-256 checksum: beab5392baf2d65843c6847da071b2ff327dad9e6f628881c42c502ad692c841 Verifying attestations