equinor / ert

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).
https://ert.readthedocs.io/en/latest/
GNU General Public License v3.0
101 stars 104 forks source link

Use plugin functionality to document forward models in Everest #8835

Open oyvindeide opened 1 day ago

oyvindeide commented 1 day ago

Ert uses the plugin system to document forward model jobs: https://github.com/equinor/ert/blob/e92f558cf14e9c9823b557b3df05caefef49576f/src/ert/shared/_doc_utils/ert_jobs.py#L17, while in Everest this is hard coded: https://github.com/equinor/ert/blob/e92f558cf14e9c9823b557b3df05caefef49576f/docs/everest/forward_model_jobs.rst?plain=1#L4.

Everest already has functionality to supply schemas from the forward model, we should be able to use that for documentation, and possibly extend from that.

We should also align this between Everest and ert so there is less duplication. For example ert now configures the forward models programmatically: https://github.com/equinor/ert/blob/9f8d73a6b4809a0384bda60632350d2123df7c0c/src/ert/plugins/hook_implementations/forward_model_steps.py#L20