# 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](https://github.com/bjornaa/ladim))
Documentation and examples are provided for each model.
## List of available plugins
| Name | Description |
|----------------------------------------------|------------------------------------------------------------------|
| [chemicals](ladim_plugins/chemicals) | Passive tracer |
| [egg](ladim_plugins/egg) | Buoyant fish eggs |
| [lunar_eel](ladim_plugins/lunar_eel) | Glass eels with lunar compass |
| [nk800met](ladim_plugins/nk800met) | Module for utilizing forcing data from the met.no thredds server |
| [release](ladim_plugins/release) | General module for creating release files |
| [salmon_lice](ladim_plugins/salmon_lice) | Salmon lice larvae |
| [sandeel](ladim_plugins/sandeel) | Sand eel larvae |
| [sedimentation](ladim_plugins/sedimentation) | Sinking particles |
| [utils](ladim_plugins/utils) | General utility functions for IBMs |
## Installation
Install using the following commands (the first command can be skipped if
LADiM is already present on your system):
```
pip install git+https://github.com/pnsaevik/ladim.git
pip install git+https://github.com/pnsaevik/ladim_plugins.git
```
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
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 a ladim output file named `out.nc`.
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` / `out.rls`.
Raw data
{
"_id": null,
"home_page": "https://github.com/pnsaevik/ladim_plugins",
"name": "ladim-plugins",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "P\u00e5l N\u00e6verlid S\u00e6vik",
"author_email": "paal.naeverlid.saevik@hi.no",
"download_url": "https://files.pythonhosted.org/packages/f7/2f/48572248a11ddeeb72122c280af480f458cf518779405825f6d9243cf7d3/ladim_plugins-2.6.0.tar.gz",
"platform": null,
"description": "# Plugins for LADiM\nThis repository contains plugins for the _Lagrangian Advection and Diffusion\nModel_ (LADiM), which is the particle tracking software used at the Institute\nof Marine Research (IMR).\n([https://github.com/bjornaa/ladim](https://github.com/bjornaa/ladim)) \n\nDocumentation and examples are provided for each model.\n\n## List of available plugins\n\n| Name | Description |\n|----------------------------------------------|------------------------------------------------------------------|\n| [chemicals](ladim_plugins/chemicals) | Passive tracer |\n| [egg](ladim_plugins/egg) | Buoyant fish eggs |\n| [lunar_eel](ladim_plugins/lunar_eel) | Glass eels with lunar compass |\n| [nk800met](ladim_plugins/nk800met) | Module for utilizing forcing data from the met.no thredds server |\n| [release](ladim_plugins/release) | General module for creating release files |\n| [salmon_lice](ladim_plugins/salmon_lice) | Salmon lice larvae |\n| [sandeel](ladim_plugins/sandeel) | Sand eel larvae |\n| [sedimentation](ladim_plugins/sedimentation) | Sinking particles |\n| [utils](ladim_plugins/utils) | General utility functions for IBMs |\n\n\n## Installation\n\nInstall using the following commands (the first command can be skipped if\nLADiM is already present on your system):\n\n```\npip install git+https://github.com/pnsaevik/ladim.git\npip install git+https://github.com/pnsaevik/ladim_plugins.git\n```\n\nThe installation can be tested with the command\n```\npytest -Wignore --pyargs ladim_plugins\n``` \nThis command will run ladim on each of the plugins, using the sample `ladim.yaml`\nand `particle.rls` files found in the subpackage folders. The tests succeed if\n`ladim` is present on the system, `ladim_plugins` is installed correctly, and the\noutput from the ladim runs matches exactly with the `out.nc` files found in the\nsubpackage folders. \n\n\n## Usage\n\n1. Copy `ladim.yaml` and `particle.rls` from the IBM subpackage of interest\n into the working directory. \n2. Make desired changes to the `yaml` and `rls` files. More detailed\n instructions are found in the `README.md` file within the subpackage.\n3. Run `ladim` and the output is written to `out.nc`. \n\n\n## Contribute\n\nTo add new plugins, contact the maintainer of the `ladim_plugins` repository. A\nproperly structured IBM subpackage has the following ingredients:\n\n1. A file `__init__.py` containing the statement `from .ibm import IBM`\n2. The IBM module itself, named `ibm.py`\n3. A `README.md` file containing instructions for use\n4. A simple test example. This includes a `ladim.yaml` configuration file,\n a `particles.rls` release file, a `forcing.nc` forcing file (may be\n copied from another subpackage), and a ladim output file named `out.nc`.\n5. Optionally a test example for generating release files. This includes a\n `release.yaml` configuration file and an output release file named\n `out.rls`.\n6. Optionally additional automated test modules, named `test_*.py`\n\nAn ideal test example should be quick to run and easy to analyze, \nbut still be complicated enough to demonstrate most\ncapabilities of the IBM model. To achieve this, it may be a good idea to use\nonly a few time steps and a few particles at selected positions. In some cases\nit may also be necessary to specify somewhat unrealistic particle parameters\nto demonstrate certain features.\n\nThe test is run using the command `pytest -Wignore --pyargs ladim_plugins`. The\ntest succeeds if ladim is able to run the examples, and the output matches the\ncontents of `out.nc` / `out.rls`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Plugins for LADiM",
"version": "2.6.0",
"project_urls": {
"Homepage": "https://github.com/pnsaevik/ladim_plugins"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3c1fdb70a9f14ab292a0d976c4173a6ce8c0ccefae35cd811228b422c78b8cbb",
"md5": "1121981a94c40d5e1ad41df55b99cb84",
"sha256": "5028fb54a8afbdacbcd28d406c0fb72696a3abc4a5b65ca87a069b22e42e6a72"
},
"downloads": -1,
"filename": "ladim_plugins-2.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1121981a94c40d5e1ad41df55b99cb84",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23580166,
"upload_time": "2025-08-13T11:27:41",
"upload_time_iso_8601": "2025-08-13T11:27:41.649209Z",
"url": "https://files.pythonhosted.org/packages/3c/1f/db70a9f14ab292a0d976c4173a6ce8c0ccefae35cd811228b422c78b8cbb/ladim_plugins-2.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f72f48572248a11ddeeb72122c280af480f458cf518779405825f6d9243cf7d3",
"md5": "4324ee82b404d002215eadaf4017d732",
"sha256": "1202d983ba788bd76062d5955b3fff5f4b6d608f5913424cec8a1722b75b0d29"
},
"downloads": -1,
"filename": "ladim_plugins-2.6.0.tar.gz",
"has_sig": false,
"md5_digest": "4324ee82b404d002215eadaf4017d732",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 23519886,
"upload_time": "2025-08-13T11:27:44",
"upload_time_iso_8601": "2025-08-13T11:27:44.330303Z",
"url": "https://files.pythonhosted.org/packages/f7/2f/48572248a11ddeeb72122c280af480f458cf518779405825f6d9243cf7d3/ladim_plugins-2.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 11:27:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pnsaevik",
"github_project": "ladim_plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ladim-plugins"
}
JSON
