ENH: Add Ert experiment id to FMU metadata block #755
Merged
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
mferrera
reviewed
Aug 21, 2024
src/fmu/dataio/_model/fields.py
Outdated
Comment on lines
562
to
564
| ert: Optional[Ert] = Field(default=None) | ||
| """The ``fmu.ert`` block contains information about the current ert run | ||
| object was exported. See :class:`Ert`.""" |
slangeveld
force-pushed
the
670-add-ert_experiment_id-to-case_metadata
branch
from
6a50273
to
164517e
Compare
mferrera
approved these changes
Aug 23, 2024
There was a problem hiding this comment.
I think this is good to go. @tnatt or @jcrivenaes should confirm before merging
tnatt
approved these changes
Aug 23, 2024
src/fmu/dataio/providers/_fmu.py
Outdated
Comment on lines
183
to
188
| ert=fields.Ert( | ||
| experiment=fields.Experiment( | ||
| id=uuid.UUID(FmuEnv.EXPERIMENT_ID.value) | ||
| if FmuEnv.EXPERIMENT_ID.value | ||
| else None | ||
| ) |
There was a problem hiding this comment.
Maybe we could pack this into a method self._get_ert_meta() since it is used two places? Then it will be more aligned with the rest 🙂
There was a problem hiding this comment.
Yes absolutely, good point!
|
Ref PR description
I think it is correct to say it will be added to the fmu metadata block |
jcrivenaes
approved these changes
Aug 23, 2024
slangeveld
changed the title
slangeveld
changed the title
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.
Resolves #670
Include _ERT_EXPERIMENT_ID from the enviroment variables in the FMU block of the exported metadata.
If the environment variable _ERT_EXPERIMENT_ID is present, it will be appended to the FMU block in the exported metadata. For this, a new "ert" field has been added to the metadata file under the FMU block, in addition to a child field "experiment", which will contain the _ERT_EXPERIMENT_ID of type UUID:
Two new tests have been added to test if the _ERT_EXPERIMENT_ID is part of the FMU metadata when it is present in the environment variables.