Skip to content

Commit

Permalink
Adjust forward model doc for FLOW
Browse files Browse the repository at this point in the history
Mention that it is now possible to select the version
  • Loading branch information
berland committed Jan 15, 2025
1 parent 024fcba commit 749fa90
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions src/ert/plugins/hook_implementations/forward_model_steps.py
Original file line number Diff line number Diff line change
Expand Up @@ -347,16 +347,19 @@ def documentation() -> ForwardModelStepDocumentation | None:
examples="""
.. code-block:: bash
FORWARD_MODEL FLOW(<ECLBASE>, <OPTS>="--ignore-errors")
FORWARD_MODEL FLOW(<ECLBASE>, <VERSION>=xxx, <OPTS>="--ignore-errors")
The :code:`OPTS` argument is optional and can be removed, thus running flow
without ignoring errors.
The :code:`OPTS` argument is optional and can be removed. :code>`ECLBASE` can
also be defaulted.
ERT will be able to run with flow only if OPM FLOW simulator is installed and available
in the user $PATH environment varaible.
Currently ERT does not support changing the default options for the flow simulator.
ERT will be able to run the flow simulator if there is a binary named
:code:`flow` or the wrapper :code:`flowrun` in the users :code:`$PATH`
environment variable.
If :code:`flowrun` is found, it will take precedence, and then it will be
possible to select the version of flow to use by setting :code:`<VERSION>`.
Available versions are verified towards what :code:`flowrun --report-versions`
returns.
""",
description="""Forward model for OPM Flow simulator""",
)
Expand Down

0 comments on commit 749fa90

Please sign in to comment.