Document forward_model_configuration hook #10610
Conversation
CodSpeed Performance ReportMerging #10610 will not alter performanceComparing Summary
|
HakonSohoel
added
the
release-notes:documentation
| @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?
There was a problem hiding this comment.
Created separate commit for this👌
| }, | ||
| } | ||
| ``<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
| 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.
HakonSohoel
force-pushed
the
Add-documentation-for-forward_model_configuration-hook
branch
from
74cd050 to
f9bd43e
Compare
| } | ||
| * ``<config value>`` can be of any python type, but will be exported to env by calling ``str(<config value>)``. | ||
| * ``config_key`` will always exposed as upper case environment variables. |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Forward model steps can be configured through the plugin system by using the ``forward_model_configuration`` hook. | ||
| For each forward model step name in the config dict, a set of configuration parameters spesific to that forward model can be spesified. |
There was a problem hiding this comment.
spesific -> specific
spesified -> specified
HakonSohoel
force-pushed
the
Add-documentation-for-forward_model_configuration-hook
branch
from
f9bd43e to
d03c803
Compare
HakonSohoel
deleted the
Add-documentation-for-forward_model_configuration-hook
branch
2 participants
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