Rename Restart run mda gui label to Select prior

* Rename mda restart labels

* Update docs to reflect gui label change

* Update codedoc to reflect checkbox label change

* Update vars to reflect gui label change

* Update prior runs list label

Author: tbwiik

docs/ert/getting_started/howto/esmda_restart.rst

@@ -13,8 +13,8 @@ One solution is to restart from ``default_2`` which is straightforward in ERT.
 
 **Steps to Restart from `default_2`:**
 
-1. Check the "Restart run" checkbox.
-2. Use the "Restart from" drop-down list to select the ensemble you wish to restart from.
+1. Check the "Select prior" checkbox.
+2. Use the "Run from" drop-down list to select the ensemble you wish to restart from.
     In this example, you'll pick ``default_2``.
 3. Click "Run Experiment".
     This creates a new ensemble which by default is called ``default_2_3``.

docs/ert/getting_started/updating_parameters/update_parameters.rst

@@ -50,8 +50,8 @@ Run data assimilation
 =====================
 
 Because we do not have any ensembles with parameters and no responses, the `Ensemble` drop down in `Evaluate ensemble` is
-now empty. To start data assimilation, navigate to the `Multiple Data Assimilation` experiment mode, and check: `Restart run`,
-then select `prior` in the `Restart from` dropdown and start the experiment. This means that we do not have to rerun the
+now empty. To start data assimilation, navigate to the `Multiple Data Assimilation` experiment mode, and check: `Select prior`,
+then select `prior` in the `Run from` dropdown and start the experiment. This means that we do not have to rerun the
 prior, and we are able to evaluate coverage of the prior without running multiple iterations of ES-MDA first.
 
 .. image:: fig/restart_es_mda.gif

src/ert/gui/experiments/multiple_data_assimilation_panel.py

@@ -62,7 +62,7 @@ class Arguments:
     target_ensemble: str
     realizations: str
     weights: str
-    restart_run: bool
+    select_prior: bool
     prior_ensemble_id: str  # UUID not serializable in json
     experiment_name: str
 
@@ -195,19 +195,21 @@ def get_ensembles_of_ensemble_experiment_type(
         layout.addRow("Active realizations:", self._active_realizations_field)
         self._active_realizations_field.setObjectName("active_realizations_box")
 
-        self._restart_box = QCheckBox("")
-        self._restart_box.setObjectName("restart_checkbox_esmda")
-        self._restart_box.toggled.connect(self.restart_run_toggled)
-        self._restart_box.toggled.connect(self.update_experiment_edit)
+        self._select_prior_box = QCheckBox("")
+        self._select_prior_box.setObjectName("select_prior_checkbox_esmda")
+        self._select_prior_box.toggled.connect(self.select_prior_toggled)
+        self._select_prior_box.toggled.connect(self.update_experiment_edit)
 
-        self._restart_box.setEnabled(bool(self._ensemble_selector._ensemble_list()))
+        self._select_prior_box.setEnabled(
+            bool(self._ensemble_selector._ensemble_list())
+        )
         self._ensemble_selector.setEnabled(False)
-        layout.addRow("Restart run:", self._restart_box)
+        layout.addRow("Select prior:", self._select_prior_box)
 
-        self._ensemble_selector.ensemble_populated.connect(self.restart_run_toggled)
+        self._ensemble_selector.ensemble_populated.connect(self.select_prior_toggled)
         self._ensemble_selector.currentIndexChanged.connect(self._realizations_from_fs)
         self._ensemble_selector.currentIndexChanged.connect(self.update_experiment_name)
-        layout.addRow("Restart from:", self._ensemble_selector)
+        layout.addRow("Run from:", self._ensemble_selector)
 
         self._experiment_name_field.getValidationSupport().validationChanged.connect(
             self.experiment_configuration_changed
@@ -286,29 +288,31 @@ def update_experiment_edit(self, checked: bool) -> None:
 
     def _evaluate_weights_box_enabled(self) -> None:
         self._relative_iteration_weights_box.setEnabled(
-            not self._restart_box.isChecked()
+            not self._select_prior_box.isChecked()
             or (
                 self._ensemble_selector.selected_ensemble is not None
                 and not self._ensemble_selector.selected_ensemble.relative_weights
             )
         )
 
-    def restart_run_toggled(self) -> None:
-        self._restart_box.setEnabled(bool(self._ensemble_selector._ensemble_list()))
-        self._ensemble_selector.setEnabled(self._restart_box.isChecked())
+    def select_prior_toggled(self) -> None:
+        self._select_prior_box.setEnabled(
+            bool(self._ensemble_selector._ensemble_list())
+        )
+        self._ensemble_selector.setEnabled(self._select_prior_box.isChecked())
 
         self._relative_iteration_weights_box.setText(
             (
                 self._ensemble_selector.selected_ensemble is not None
                 and self._ensemble_selector.selected_ensemble.relative_weights
             )
             or self._configured_weights
-            if self._restart_box.isChecked()
+            if self._select_prior_box.isChecked()
             else self._configured_weights
         )
         self._weights_source = self._relative_iteration_weights_box.text()
         self._update_weights_mismatch_warning()
-        if self._restart_box.isChecked():
+        if self._select_prior_box.isChecked():
             self._active_realizations_field.setValidator(
                 self._previous_ensemble_realizations_validator
             )
@@ -418,11 +422,11 @@ def get_experiment_arguments(self) -> Arguments:
             target_ensemble=self._target_ensemble_format_model.getValue(),  # type: ignore
             realizations=self._active_realizations_field.text(),
             weights=self.weights,
-            restart_run=self._restart_box.isChecked(),
+            select_prior=self._select_prior_box.isChecked(),
             prior_ensemble_id=(
                 str(self._ensemble_selector.selected_ensemble.id)
                 if self._ensemble_selector.selected_ensemble is not None
-                and self._restart_box.isChecked()
+                and self._select_prior_box.isChecked()
                 else ""
             ),
             experiment_name=self._experiment_name_field.get_text,

src/ert/run_models/model_factory.py

@@ -463,18 +463,18 @@ def _determine_restart_info(args: Namespace) -> tuple[bool, str | None]:
 
     Returns
     -------
-    A tuple containing the restart_run flag and the ensemble
+    A tuple containing the select_prior flag and the ensemble
     to run from.
     """
     if hasattr(args, "restart_ensemble_id"):
         # When running from CLI
-        restart_run = args.restart_ensemble_id is not None
+        select_prior = args.restart_ensemble_id is not None
         prior_ensemble = args.restart_ensemble_id or ""
     else:
         # When running from GUI
-        restart_run = args.restart_run
+        select_prior = args.select_prior
         prior_ensemble = args.prior_ensemble_id
-    return restart_run, prior_ensemble
+    return select_prior, prior_ensemble
 
 
 def _setup_multiple_data_assimilation(
@@ -483,7 +483,7 @@ def _setup_multiple_data_assimilation(
     update_settings: ObservationSettings,
     status_queue: SimpleQueue[StatusEvents],
 ) -> MultipleDataAssimilation:
-    restart_run, prior_ensemble = _determine_restart_info(args)
+    select_prior, prior_ensemble = _determine_restart_info(args)
     active_realizations = _get_and_validate_active_realizations_list(args, config)
     validate_minimum_realizations(config, active_realizations)
     if sum(active_realizations) < 2:
@@ -492,7 +492,7 @@ def _setup_multiple_data_assimilation(
         )
 
     parameter_configs, design_matrix = _merge_parameters(
-        design_matrix=None if restart_run else config.analysis_config.design_matrix,
+        design_matrix=None if select_prior else config.analysis_config.design_matrix,
         parameter_configs=config.ensemble_config.parameter_configuration,
         require_updateable_param=True,
     )
@@ -502,7 +502,7 @@ def _setup_multiple_data_assimilation(
         active_realizations=active_realizations,
         target_ensemble=_iterative_ensemble_format(args),
         arg_weights=args.weights,
-        restart_run=restart_run,
+        select_prior=select_prior,
         prior_ensemble_id=prior_ensemble,
         minimum_required_realizations=config.analysis_config.minimum_required_realizations,
         experiment_name=args.experiment_name,

src/ert/run_models/multiple_data_assimilation.py

@@ -49,7 +49,7 @@ def model_post_init(self, ctx: Any) -> None:
         self._parsed_weights = self.parse_weights(self.analysis_settings.weights)
         start_iteration = 0
         total_iterations = len(self._parsed_weights) + 1
-        if self.restart_run:
+        if self.select_prior:
             if not self.prior_ensemble_id:
                 raise ValueError("For restart run, prior ensemble must be set")
             start_iteration = (
@@ -93,7 +93,7 @@ def run_experiment(
             raise ErtRunError("ESMDA does not support restart")
 
         target_experiment = None
-        if self.restart_run:
+        if self.select_prior:
             id_ = self.prior_ensemble_id
             assert id_ is not None
 

src/ert/run_models/run_model_configs.py

@@ -320,7 +320,7 @@ class MultipleDataAssimilationConfig(
     InitialEnsembleRunModelConfig, UpdateRunModelConfig
 ):
     experiment_type: ExperimentType = ExperimentType.ES_MDA
-    restart_run: bool
+    select_prior: bool
     prior_ensemble_id: str | None
     arg_weights: str | None = Field(default=None, exclude=True)
 
@@ -337,7 +337,7 @@ def to_experiment_config(self) -> ExperimentConfig:
             **self._initial_ensemble_experiment_config(),
             **self._update_experiment_config(),
             **self._common_fields(),
-            "restart_run": self.restart_run,
+            "select_prior": self.select_prior,
             "prior_ensemble_id": self.prior_ensemble_id,
             "experiment_type": ExperimentType.ES_MDA,
         }

src/ert/storage/local_experiment.py

@@ -117,7 +117,7 @@ class ExperimentConfig(TypedDict, total=False):
     ensemble_id: str
 
     # ESMDA
-    restart_run: bool
+    select_prior: bool
     prior_ensemble_id: str | None
 
     # Everest

tests/ert/ui_tests/cli/test_restarting_esmda.py

@@ -225,7 +225,7 @@ def _build_esmda_restart_model(prior_ensemble_id: str):
             realizations=None,
             target_ensemble="iter-<ITER>",
             weights="1,1",
-            restart_run=True,
+            select_prior=True,
             prior_ensemble_id=prior_ensemble_id,
             experiment_name="restart-experiment",
         ),

tests/ert/ui_tests/gui/test_main_window.py

@@ -736,7 +736,7 @@ def right_click_plotter_button() -> None:
     gui.close()
 
 
-def test_that_es_mda_restart_run_box_is_disabled_when_there_are_no_valid_cases(
+def test_that_es_mda_select_prior_box_is_disabled_when_there_are_no_valid_cases(
     qtbot, opened_main_window_minimal_realizations, run_experiment
 ):
     gui = opened_main_window_minimal_realizations
@@ -751,7 +751,9 @@ def test_that_es_mda_restart_run_box_is_disabled_when_there_are_no_valid_cases(
     es_mda_panel = get_child(gui, QWidget, name="ES_MDA_panel")
     assert es_mda_panel
 
-    restart_button = get_child(es_mda_panel, QCheckBox, name="restart_checkbox_esmda")
+    restart_button = get_child(
+        es_mda_panel, QCheckBox, name="select_prior_checkbox_esmda"
+    )
     ensemble_selector = get_child(es_mda_panel, EnsembleSelector)
 
     assert restart_button

tests/ert/ui_tests/gui/test_restart_esmda.py

@@ -21,10 +21,12 @@ def test_restart_esmda(ensemble_experiment_has_run_no_failure, qtbot):
 
     es_mda_panel = gui.findChild(QWidget, name="ES_MDA_panel")
     assert es_mda_panel
-    restart_checkbox = es_mda_panel.findChild(QCheckBox, name="restart_checkbox_esmda")
-    assert restart_checkbox
-    restart_checkbox.click()
-    assert restart_checkbox.isChecked()
+    select_prior_checkbox = es_mda_panel.findChild(
+        QCheckBox, name="select_prior_checkbox_esmda"
+    )
+    assert select_prior_checkbox
+    select_prior_checkbox.click()
+    assert select_prior_checkbox.isChecked()
 
     es_mda_panel._ensemble_selector.setCurrentText("iter-0")
     assert es_mda_panel._ensemble_selector.selected_ensemble.name == "iter-0"
@@ -72,12 +74,14 @@ def test_that_esmda_active_realizations_are_set_only_when_restart_is_checked(
     active_reals = es_mda_panel.findChild(StringBox, "active_realizations_box")
     assert active_reals.text() == "0-9"
 
-    restart_checkbox = es_mda_panel.findChild(QCheckBox, name="restart_checkbox_esmda")
-    assert restart_checkbox
-    assert not restart_checkbox.isChecked()
-    restart_checkbox.click()
+    select_prior_checkbox = es_mda_panel.findChild(
+        QCheckBox, name="select_prior_checkbox_esmda"
+    )
+    assert select_prior_checkbox
+    assert not select_prior_checkbox.isChecked()
+    select_prior_checkbox.click()
     assert active_reals.text() == "0-1"
-    restart_checkbox.click()
+    select_prior_checkbox.click()
     assert active_reals.text() == "0-9"
 
 
@@ -117,11 +121,13 @@ def test_custom_weights_stored_and_retrieved_from_metadata_esmda(
         == "Total progress 100% — Experiment completed."
     )
     assert wsb.text() == default_weights
-    restart_checkbox = es_mda_panel.findChild(QCheckBox, name="restart_checkbox_esmda")
-    assert restart_checkbox
-    assert not restart_checkbox.isChecked()
-    restart_checkbox.click()
+    select_prior_checkbox = es_mda_panel.findChild(
+        QCheckBox, name="select_prior_checkbox_esmda"
+    )
+    assert select_prior_checkbox
+    assert not select_prior_checkbox.isChecked()
+    select_prior_checkbox.click()
     # selecting restart will trigger reading of metadata.json containing custom weights
-    assert restart_checkbox.isChecked()
+    assert select_prior_checkbox.isChecked()
     assert not wsb.isEnabled()
     assert wsb.text() == custom_weights