Document forward_model_configuration hook #10610
Open
Conversation
This file contains hidden or 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
CodSpeed Performance ReportMerging #10610 will not alter performanceComparing Summary
|
HakonSohoel
added
the
release-notes:documentation
berland
reviewed
Apr 15, 2025
| @@ -22,7 +22,7 @@ def installable_forward_model_steps() -> PluginResponse[ | |||
|
|
|||
| @no_type_check | |||
| @hook_specification | |||
| def forward_model_configuration() -> PluginResponse[list[type[ForwardModelStepPlugin]]]: | |||
| def forward_model_configuration() -> PluginResponse[dict[str, dict[str, Any]]]: | |||
There was a problem hiding this comment.
Was this not caught by mypy?
Should it be in a separate commit with a separate message?
berland
reviewed
Apr 15, 2025
| }, | ||
| } | ||
|
|
||
| ``<config value>`` can be of any python type, but will be exported to env by calling ``str(<config value>)``. |
There was a problem hiding this comment.
We should also mention that config_key is case-insensitive (at least upper-cased, check tests)
There was a problem hiding this comment.
Not really case-insensitive, but the environment variables are upper-case no matter what is put in the configuration
berland
reviewed
Apr 15, 2025
| Forward model configuration | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Forward model steps can be configured through the plugin system by using the ``forward_model_configuration`` hook: |
There was a problem hiding this comment.
This introduction should mention that the configuration is about specific environment variables that Ert will inject when starting the forward model.
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.
Issue
Resolves #9699
Approach
Short description of the approach
(Screenshot of new behavior in GUI if applicable)
git rebase -i main --exec 'just rapid-tests')When applicable