https://github.com/deltares/imod-documentation
📚 Documentation of the iMOD suite.
https://github.com/deltares/imod-documentation
3d-viewer groundwater imod modflow qgis-plugin
Last synced: 4 months ago
JSON representation
📚 Documentation of the iMOD suite.
- Host: GitHub
- URL: https://github.com/deltares/imod-documentation
- Owner: Deltares
- Created: 2021-09-14T14:38:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T03:24:25.000Z (about 1 year ago)
- Last Synced: 2025-05-01T04:26:27.685Z (about 1 year ago)
- Topics: 3d-viewer, groundwater, imod, modflow, qgis-plugin
- Homepage: https://deltares.github.io/iMOD-Documentation/
- Size: 116 MB
- Stars: 4
- Watchers: 6
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# iMOD Suite Documentation
[The iMOD Suite documentation is generated here.](https://deltares.github.io/iMOD-Documentation)
The documentation is set up using [Quarto](https://quarto.org/).
[Read here how to get started using Quarto.](https://quarto.org/docs/get-started/)
If you want to contribute to the iMOD Suite documentation,
please read the [contributing guidelines](CONTRIBUTING.md).
## Local Build
1. [Install Quarto](https://quarto.org/docs/get-started/) and [pixi](https://pixi.sh)
2. `git clone https://github.com/Deltares/iMOD-Documentation.git`
3. `cd iMOD-Documentation`
4. `pixi run install-pre-commit`
5. `pixi run docs`
6. To render PDF (deleting any previously build documentation):
`quarto render docs --profile manual --to pdf`
## Project setup
The Quarto project is set up using different profiles, specified in the
`_quarto-.yml` files. These are:
- `website`: The website, render as html
- `manual`: The full user manual, render as pdf
- `install`: The installation guide, render as pdf. Can be shipped with the release.
- `tutorial`: The tutorial pages, render as pdf. Can be used during trainings.