IGM Documentation

Source for the igm-model.org documentation site, built with MkDocs Material. The IGM source code lives at github.com/instructed-glacier-model/igm.

Setup

Clone the main IGM repository and initialise submodules:

git clone https://github.com/instructed-glacier-model/igm
cd igm/
git submodule update --init

Create a dedicated environment and install the documentation dependencies:

conda create -n igm-doc python=3.11
conda activate igm-doc
conda install -c conda-forge pandoc
pip install mkdocs-material mkdocs-include-markdown-plugin mkdocs-macros-plugin mkdocs-table-reader-plugin mkdocs-bibtex

Local preview

conda activate igm-doc
mkdocs serve

Open the URL printed in the terminal. Changes to any source file are reflected live in the browser.

Pushing changes

Changes must be committed in both igm-doc and the parent igm repository:

# 1. In igm-doc/
git pull
# make your changes
git add .
git commit -m "docs: describe what you changed"
git push

# 2. In igm/
git add igm-doc
git commit -m "docs: bump igm-doc submodule"
git push

Structure

Path	Purpose
docs/	Markdown source files
mkdocs.yml	Site configuration and navigation
main.py	MkDocs Macros plugin — custom Python macros used in pages
refs.bib	BibTeX references (rendered by mkdocs-bibtex)
module_io.yaml	Module input/output definitions (used by dependency graph and macros)
process_dependency_viz.py	Script to regenerate docs/assets/dependency_graph.html

---

Maintainers

The documentation is maintained by Guillaume Jouvet (@jouvetg), Brandon Finley (@brfi3983), Thomas Gregov (@tgregov), and Sebastian Rosier (@shrrosier).