ERT - Ensemble based Reservoir Tool - is designed for running ensembles of dynamical models such as reservoir models, in order to do sensitivity analysis and data assimilation. ERT supports data assimilation using the Ensemble Smoother (ES), Ensemble Smoother with Multiple Data Assimilation (ES-MDA) and Iterative Ensemble Smoother (IES).
Ert uses sphinx, which is a very broadly used documentation software. However, there are pain points, like slow build times, no live reload and use of ReStructured Text (subjective).
Instead, I would like to use mkdocs, which has the mkdocstring plugin that lets one easily document most everything in Python docstrings, with live reload. A notable user is Pydantic.
One difficulty is implementing documentation from Ert plugins, where it is provided at runtime and in RST format rather than mkdocs' Markdown.
Ert uses sphinx, which is a very broadly used documentation software. However, there are pain points, like slow build times, no live reload and use of ReStructured Text (subjective).
Instead, I would like to use mkdocs, which has the mkdocstring plugin that lets one easily document most everything in Python docstrings, with live reload. A notable user is Pydantic.
One difficulty is implementing documentation from Ert plugins, where it is provided at runtime and in RST format rather than mkdocs' Markdown.