Skip to main content

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.yaml files found in the subpackage folders.

Usage

  1. Copy ladim.yaml and particle.rls from the IBM subpackage of interest into the working directory.
  2. Make desired changes to the yaml and rls files. More detailed instructions are found in the README.md file within the subpackage.
  3. 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:

  1. A file __init__.py containing the statement from .ibm import IBM
  2. The IBM module itself, named ibm.py
  3. A README.md file containing instructions for use
  4. 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 the ladim output stored as yaml, named out.nc.yaml (it is created by the test if it does not exist).
  5. Optionally a test example for generating release files. This includes a release.yaml configuration file and an output release file named out.rls.
  6. 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.yaml / out.rls.

Metadata

Release files for ladim-plugins 2.12.0

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.12.0
File Size Uploaded Provenance Actions
ladim_plugins-2.12.0.tar.gz 23.5 MB With provenance Details for ladim_plugins-2.12.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ladim-plugins 2.12.0
File Interpreter ABI Platform Actions
ladim_plugins-2.12.0-py3-none-any.whl Python 3 none any Details for ladim_plugins-2.12.0-py3-none-any.whl

Total release size: 47.0 MB

Release files / ladim_plugins-2.12.0.tar.gz

Download URL ladim_plugins-2.12.0.tar.gz
Size 23.5 MB
Tags Source
SHA-256 checksum
How to use checksums
3c24f9ae27cdb56a5712c650f6b2dca15a4e14221f00a4534d094ed4b9bf18a1
BLAKE2b-256 checksum
How to use checksums
e7ff74f5700295b0a46eb4af7463e96059067702d2617593432f2c22a0ece5a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

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

Download URL ladim_plugins-2.12.0-py3-none-any.whl
Size 23.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
654e10ec54149d8ba08e57db583b2a75ef01b80479a24358c6bd2d217383841c
BLAKE2b-256 checksum
How to use checksums
77bc01ec5dcfd1704c10d0236ff4c7ce05420bf1195f8239eb75dc77c9bb8518
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

Security for ladim-plugins 2.12.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ladim_plugins-2.12.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 19, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page