IRMA (Installation, Reliability, Maintenance, and Analysis) is a modeling and scheduling tool for marine operations.
Ensure you have a version of Anaconda or Miniconda to work with Python.
From a terminal:
conda create -n <environment_name> python=3.11
conda activate <environment_name>
Navigate to the IRMA directory and run
pip install -e .
There are currently some other steps that you will need to take in the code's current form, such as cloning and navigating to the repository of FAD-Toolset and running pip install -e . from there, as well as manually installing some other dependencies like moorpy, ruamel.yaml, and shapely.
FAD-Toolset and MoorPy releases are planned for March 2026, which will allow much cleaner environment setup and organization.
TODO: add specific (tested) versions of each dependency to ensure compatbility
Different documentation themese can be used and included in mkdocs.yml (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
To update documentation:
pip install mkdocs
pip install mkdocs-material (or any other theme)
There should already be a docs/ folder and a mkdocs.yml settings file
Make updates to mkdocs.yml and/or the actual documentation markdown files
Run mkdocs serve to preview locally
Run mkdocs gh-deploy to publish to GitHub Pages