diff --git a/src/ert/plugins/hook_implementations/forward_model_steps.py b/src/ert/plugins/hook_implementations/forward_model_steps.py index 780ab524e4c..19936af7478 100644 --- a/src/ert/plugins/hook_implementations/forward_model_steps.py +++ b/src/ert/plugins/hook_implementations/forward_model_steps.py @@ -237,26 +237,34 @@ def validate_pre_experiment(self, fm_json: ForwardModelStepJSON) -> None: @staticmethod def documentation() -> ForwardModelStepDocumentation | None: return ForwardModelStepDocumentation( - description="The Eclipse 100 black-oil reservoir simulator from SLB", + description="""The Eclipse 100 black-oil reservoir simulator from SLB. + +If you have used the :ref:`DATA_FILE ` keyword Ert will parse the +DATA-file for the :code:`PARALLEL` keyword and set up the correct number of +CPUs. If the :code:`PARALLEL` keyword is set up/computed during the forward +model, then :code:`NUM_CPU` must be set in the Ert config for correct +configuration of CPU usage. + """, category="simulators.reservoir", examples=""" -The version, number of cpu, and whether or not to ignore errors and whether -or not to produce `YOUR_CASE_NAME.h5` output files can be configured in the -configuration file when adding the job, as such: +The version, whether or not to ignore errors and whether or not to produce +:code:`YOUR_CASE_NAME.h5` output files can be configured in the configuration +file when adding the job, as such: .. code-block:: bash - FORWARD_MODEL ECLIPSE100(, =xxxx, \ - ={"--ignore-errors", "--summary-conversion"}) + FORWARD_MODEL ECLIPSE100(, =xxxx, \\ + ="--ignore-errors --summary-conversion") The :code:`OPTS` argument is optional and can be removed, fully or partially. In absence of :code:`--ignore-errors` eclipse will fail on errors. Adding the flag :code:`--ignore-errors` will result in eclipse ignoring errors. -And in absence of :code:`--summary-conversions` eclipse will run without producing -`YOUR_CASE_NAME.h5` output files. Add flag :code:`--summary-conversions` to produce -`YOUR_CASE_NAME.h5` output files. +And in absence of :code:`--summary-conversions` eclipse will run without +producing :code:`YOUR_CASE_NAME.h5` output files. Add flag +:code:`--summary-conversion` to produce :code:`YOUR_CASE_NAME.h5` output +files. """, ) @@ -305,18 +313,25 @@ def validate_pre_experiment( @staticmethod def documentation() -> ForwardModelStepDocumentation | None: return ForwardModelStepDocumentation( - description="The Eclipse 300 compositional reservoir simulator from SLB", + description="""The Eclipse 300 compositional reservoir simulator from SLB. + +If you have used the :ref:`DATA_FILE ` keyword Ert will parse the +DATA-file for the :code:`PARALLEL` keyword and set up the correct number of +CPUs. If the :code:`PARALLEL` keyword is set up/computed during the forward +model, then :code:`NUM_CPU` must be set in the Ert config for correct +configuration of CPU usage. +""", category="simulators.reservoir", examples=""" -The version, number of cpu and whether or not to ignore errors can -be configured in the configuration file when adding the job, as such: +The version and whether or not to ignore errors can be configured in the +configuration file when adding the step, as such: .. code-block:: bash FORWARD_MODEL ECLIPSE300(, =xxxx, ="--ignore-errors") The :code:`OPTS` argument is optional and can be removed, thus running eclipse -without ignoring errors +without ignoring errors. """, ) @@ -368,15 +383,12 @@ def validate_pre_experiment(self, fm_json: ForwardModelStepJSON) -> None: @staticmethod def documentation() -> ForwardModelStepDocumentation | None: return ForwardModelStepDocumentation( - category="simulators.reservoir", - examples=""" -.. code-block:: bash - - FORWARD_MODEL FLOW(, =xxx, ="--ignore-errors") + description="""Forward model for OPM Flow simulator. -The :code:`OPTS` argument is optional and can be skipped. :code:`ECLBASE` can -also be defaulted. Multiple options in :code:`OPTS` can be supplied by -separating them with a space. +Flow will be run with the number of CPUs defined either through the keyword +:code:`NUM_CPU` or parsed from the :code:`PARALLEL` keyword in the DATA file +(requires usage of the :ref:`DATA_FILE ` keyword) if :code:`NUM_CPU` +is not set. ERT will be able to run the flow simulator if there is an executable named :code:`flow` or :code:`flowrun` found in the user's :code:`$PATH` environment @@ -385,9 +397,22 @@ def documentation() -> ForwardModelStepDocumentation | None: 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:``. Available versions are verified towards what :code:`flowrun --report-versions` -returns. +returns. An appropriate setting for the threads parameter (per CPU core) +will automatically be selected if :code:`flowrun` is found. + +Any options that should be forwarded to the simulator should be included +in the :code:`` argument, multiple arguments can be supplied by +separating them with a space. +""", + category="simulators.reservoir", + examples=""" +.. code-block:: bash + + FORWARD_MODEL FLOW(, =rc46, ="--ignore-errors") + +The :code:`OPTS` argument is optional and can be skipped. :code:`ECLBASE` can +also be defaulted. """, - description="""Forward model for OPM Flow simulator""", )