Clarify gen data docs #6984
Merged
Clarify gen data docs #6984
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yngve-sk
force-pushed
the
clarify-gen-data-docs
branch
2 times, most recently
from
40cfda6 to
7685445
Compare
yngve-sk
force-pushed
the
clarify-gen-data-docs
branch
2 times, most recently
from
e7986dd to
1b1bf78
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6984 +/- ##
==========================================
+ Coverage 84.37% 84.39% +0.02%
==========================================
Files 367 367
Lines 21882 21882
Branches 900 900
==========================================
+ Hits 18462 18468 +6
+ Misses 3126 3120 -6
Partials 294 294 ☔ View full report in Codecov by Sentry. |
yngve-sk
force-pushed
the
clarify-gen-data-docs
branch
from
1b1bf78 to
72908ee
Compare
jonathan-eq
approved these changes
Jan 22, 2024
larsevj
reviewed
Jan 22, 2024
| :ref:`GENERAL_OBSERVATIONs <general_observation>`. It declares | ||
| text files which have been generated by the forward model, which will be | ||
| loaded by ert when loading general observations. | ||
| These text files naming scheme may be arbitrary. The contents of these result files are always: |
There was a problem hiding this comment.
Maybe change: files -> files', in "These text files naming scheme may be arbitrary.".
|
|
||
| The GEN_DATA keyword has several options, each of them required: | ||
|
|
||
| * RESULT_FILE - This is the name of the file generated by the forward | ||
| model and read by ERT. This filename _must_ have a %d as part of the | ||
| name, that %d will be replaced by report step when loading. | ||
| * INPUT_FORMAT - The format of the file written by the forward model |
There was a problem hiding this comment.
Is the INPUT_FORMAT deprecated?
There was a problem hiding this comment.
Yes it is, no longer in use
yngve-sk
force-pushed
the
clarify-gen-data-docs
branch
from
72908ee to
fa29a5f
Compare
oyvindeide
reviewed
Jan 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal: Describe less ambiguously what a GEN_DATA result file must contain, why it is specified and how it is used. Also remove deprecated
INPUT_FORMATdoc