Skip to content

Commit

Permalink
Add formatting to simulation mode helptext
Browse files Browse the repository at this point in the history
* Add formatting to simulation mode helptext
* Emphasize realization-0 executed only
  • Loading branch information
andreas-el authored Sep 30, 2024
1 parent 03d3f9b commit 0e88cbd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 11 deletions.
4 changes: 2 additions & 2 deletions src/ert/run_models/ensemble_experiment.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
class EnsembleExperiment(BaseRunModel):
"""
This workflow will create a new experiment and a new ensemble from
the user configuration. It will never overwrite existing ensembles, and
will always sample parameters.
the user configuration.<br>It will never overwrite existing ensembles, and
will always sample parameters.<br>
"""

def __init__(
Expand Down
10 changes: 4 additions & 6 deletions src/ert/run_models/evaluate_ensemble.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,10 @@
# pylint: disable=too-many-arguments
class EvaluateEnsemble(BaseRunModel):
"""
This workflow will evaluate ensembles which have parameters, but no
simulation has been performed, so there are no responses. This can
be used in instances where the parameters are sampled manually, or
after performing a manual update step. This will always read parameter
and response configuration from the stored ensemble, and will not
reflect any changes to the user configuration on disk.
This workflow will evaluate ensembles which have parameters, but no simulation has been performed, so there are no responses.<br>
This can be used in instances where the parameters are sampled manually, or after performing a manual update step.<br>
The workflow will always read parameter and response configuration from the stored ensemble,<br>
and will not reflect any changes to the user configuration on disk.<br>
"""

def __init__(
Expand Down
6 changes: 3 additions & 3 deletions src/ert/run_models/single_test_run.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
class SingleTestRun(EnsembleExperiment):
"""
Single test is equivalent to EnsembleExperiment, in that it
samples the prior and evaluates it. There are two key differences:
1) Single test run always runs locally using the local queue
2) Only a single realization is run
samples the prior and evaluates it.<br>There are two key differences:<br>
1) Single test run always runs locally using the <b>local queue</b><br>
2) Only a <b>single realization</b> (realization-0) is run<br>
"""

def __init__(
Expand Down

0 comments on commit 0e88cbd

Please sign in to comment.