From 5414ccd3952da7729177fce9725b74734c549ece Mon Sep 17 00:00:00 2001 From: "Yngve S. Kristiansen" Date: Wed, 23 Oct 2024 11:17:43 +0200 Subject: [PATCH] Add some documentation to _update_response_keys --- src/ert/storage/local_ensemble.py | 2 +- src/ert/storage/local_experiment.py | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/ert/storage/local_ensemble.py b/src/ert/storage/local_ensemble.py index 2ce416e194c..41b0a7d8e5e 100644 --- a/src/ert/storage/local_ensemble.py +++ b/src/ert/storage/local_ensemble.py @@ -878,7 +878,7 @@ def save_response( ) response_keys = data["response_key"].unique().to_list() - self.experiment.update_response_keys(response_type, response_keys) + self.experiment._update_response_keys(response_type, response_keys) def calculate_std_dev_for_parameter(self, parameter_group: str) -> xr.Dataset: if parameter_group not in self.experiment.parameter_configuration: diff --git a/src/ert/storage/local_experiment.py b/src/ert/storage/local_experiment.py index 674a20abfe6..bef4cf46ea2 100644 --- a/src/ert/storage/local_experiment.py +++ b/src/ert/storage/local_experiment.py @@ -342,9 +342,15 @@ def response_key_to_response_type(self) -> Dict[str, str]: return mapping - def update_response_keys( + def _update_response_keys( self, response_type: str, new_response_keys: List[str] ) -> None: + """ + When a response is saved to storage, it may contain keys + that are not explicitly declared in the config. Calling this ensures + that the response config saved in this storage has keys corresponding + to the actual received responses. + """ if not any( k for k in new_response_keys if k not in self.response_key_to_response_type ):