Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update forward model doc for FLOW #9741

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 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,20 @@ 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. Multiple options can be supplied by separating them
with a space.

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
Loading