Update documentation on reservoir simulators - #14318
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #14318 +/- ##
==========================================
- Coverage 91.92% 91.74% -0.19%
==========================================
Files 485 485
Lines 33655 34708 +1053
==========================================
+ Hits 30939 31844 +905
- Misses 2716 2864 +148
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Pull request overview
Updates the forward model step documentation strings for reservoir simulators, aiming to clarify CPU handling (NUM_CPU vs parsing PARALLEL) and to correct/clarify configuration examples shown in generated docs.
Changes:
- Expanded Eclipse 100 / Eclipse 300 documentation to explain how CPU count is determined via
PARALLELvsNUM_CPU. - Updated examples to fix multiline backslash rendering and to show multiple
<OPTS>passed as a space-separated string (not curly braces). - Expanded Flow documentation to describe CPU selection behavior and forwarding multiple options via
<OPTS>.
Suppressed comments (2)
src/ert/plugins/hook_implementations/forward_model_steps.py:320
- Minor wording/grammar: use “set up” (verb) rather than “setup” in the description text.
Ert will parse the DATA-file for the :code:`PARALLEL` keyword and setup the
correct number of CPUs. If the :code:`PARALLEL` keyword is setup/computed
during the forward model, then :code:`NUM_CPU` must be set in the Ert config
for correct configuration of CPU usage.
src/ert/plugins/hook_implementations/forward_model_steps.py:397
- Capitalization/terminology: “CPU” is typically uppercased in this context ("per CPU core").
returns. An appropriate setting for the threads parameter (per cpu core)
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Explicitly state how NUM_CPU should be handled for Eclipse and Flow. Fix backslash rendering bug for multiline Ert config examples Fix erroneous example on supplying multiple options to Eclipse 100. Curly braces do not work.
6abe85b to
f0420d3
Compare
| description="The Eclipse 300 compositional reservoir simulator from SLB", | ||
| description="""The Eclipse 300 compositional reservoir simulator from SLB. | ||
|
|
||
| Ert will parse the DATA-file for the :code:`PARALLEL` keyword and set up the |
There was a problem hiding this comment.
Suggest linking to the DATA_FILE-keyword, as that is needed for us to parse it to read PARALLEL, same for ecl100.
|
Screenshots differ from baselines. A baseline update PR has been prepared: equinor/ert-testdata#113 |
False positive due to missing merge in equinor/ert-testdata#106 |
Explicitly state how NUM_CPU should be handled for Eclispe and Flow.
Fix backslash rendering bug for multiline Ert config examples
Fix erroneous example on supplying multiple options to Eclipse 100. Curly braces do not work.
Issue
Resolves gruff
Approach
🧠 ✍🏻
git rebase -i main --exec 'just rapid-tests')When applicable
merge screenshot-PR in ert-testdata before merging this PR.