Add EnIF to GUI

Author: yngve-sk

src/ert/gui/simulation/ensemble_information_filter_panel.py

@@ -0,0 +1,147 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from PyQt6.QtCore import pyqtSlot as Slot
+from PyQt6.QtWidgets import QFormLayout, QLabel, QWidget
+
+from ert.gui.ertnotifier import ErtNotifier
+from ert.gui.ertwidgets import (
+    ActiveRealizationsModel,
+    AnalysisModuleEdit,
+    CopyableLabel,
+    StringBox,
+    TargetEnsembleModel,
+    TextModel,
+)
+from ert.mode_definitions import ENIF_MODE
+from ert.run_models import EnsembleInformationFilter
+from ert.validation import (
+    ExperimentValidation,
+    ProperNameFormatArgument,
+    RangeStringArgument,
+)
+
+from ._design_matrix_panel import DesignMatrixPanel
+from .experiment_config_panel import ExperimentConfigPanel
+
+if TYPE_CHECKING:
+    from ert.config import AnalysisConfig
+
+
+@dataclass
+class Arguments:
+    mode: str
+    target_ensemble: str
+    realizations: str
+    experiment_name: str
+
+
+class EnsembleInformationFilterPanel(ExperimentConfigPanel):
+    def __init__(
+        self,
+        analysis_config: AnalysisConfig,
+        run_path: str,
+        notifier: ErtNotifier,
+        ensemble_size: int,
+    ) -> None:
+        super().__init__(EnsembleInformationFilter)
+        self.notifier = notifier
+
+        layout = QFormLayout()
+        self.setObjectName("enif_panel")
+
+        self._experiment_name_field = StringBox(
+            TextModel(""),
+            placeholder_text=self.notifier.storage.get_unique_experiment_name(
+                ENIF_MODE
+            ),
+        )
+        self._experiment_name_field.setMinimumWidth(250)
+        self._experiment_name_field.setValidator(
+            ExperimentValidation(self.notifier.storage)
+        )
+        self._experiment_name_field.setObjectName("experiment_field")
+        layout.addRow("Experiment name:", self._experiment_name_field)
+
+        runpath_label = CopyableLabel(text=run_path)
+        layout.addRow("Runpath:", runpath_label)
+
+        number_of_realizations_label = QLabel(f"<b>{ensemble_size}</b>")
+        layout.addRow(QLabel("Number of realizations:"), number_of_realizations_label)
+
+        self._ensemble_format_model = TargetEnsembleModel(analysis_config, notifier)
+        self._ensemble_format_field = StringBox(
+            self._ensemble_format_model,  # type: ignore
+            self._ensemble_format_model.getDefaultValue(),  # type: ignore
+            continuous_update=True,
+        )
+        self._ensemble_format_field.setValidator(ProperNameFormatArgument())
+        layout.addRow("Ensemble format:", self._ensemble_format_field)
+
+        self._analysis_module_edit = AnalysisModuleEdit(
+            analysis_config.es_module, ensemble_size
+        )
+        self._analysis_module_edit.setObjectName("enif_edit")
+        layout.addRow("Analysis module:", self._analysis_module_edit)
+
+        active_realizations_model = ActiveRealizationsModel(ensemble_size)
+        self._active_realizations_field = StringBox(
+            active_realizations_model,  # type: ignore
+            "config/simulation/active_realizations",
+        )
+        self._active_realizations_field.setValidator(RangeStringArgument(ensemble_size))
+        layout.addRow("Active realizations", self._active_realizations_field)
+
+        design_matrix = analysis_config.design_matrix
+        if design_matrix is not None:
+            layout.addRow(
+                "Design Matrix",
+                DesignMatrixPanel.get_design_matrix_button(
+                    self._active_realizations_field,
+                    design_matrix,
+                    number_of_realizations_label,
+                    ensemble_size,
+                ),
+            )
+
+        self.setLayout(layout)
+
+        self._experiment_name_field.getValidationSupport().validationChanged.connect(
+            self.simulationConfigurationChanged
+        )
+        self._ensemble_format_field.getValidationSupport().validationChanged.connect(
+            self.simulationConfigurationChanged
+        )
+        self._active_realizations_field.getValidationSupport().validationChanged.connect(
+            self.simulationConfigurationChanged
+        )
+
+        self.notifier.ertChanged.connect(self._update_experiment_name_placeholder)
+
+    @Slot(QWidget)
+    def experimentTypeChanged(self, w: QWidget) -> None:
+        if isinstance(w, EnsembleInformationFilterPanel):
+            self._update_experiment_name_placeholder()
+
+    def _update_experiment_name_placeholder(self) -> None:
+        self._experiment_name_field.setPlaceholderText(
+            self.notifier.storage.get_unique_experiment_name(ENIF_MODE)
+        )
+
+    def isConfigurationValid(self) -> bool:
+        return (
+            self._experiment_name_field.isValid()
+            and self._ensemble_format_field.isValid()
+            and self._active_realizations_field.isValid()
+        )
+
+    def get_experiment_arguments(self) -> Arguments:
+        arguments = Arguments(
+            mode=ENIF_MODE,
+            target_ensemble=self._ensemble_format_model.getValue(),  # type: ignore
+            realizations=self._active_realizations_field.text(),
+            experiment_name=self._experiment_name_field.get_text,
+        )
+        return arguments

src/ert/gui/simulation/experiment_panel.py

@@ -30,6 +30,7 @@
 from ..summarypanel import SummaryPanel
 from .combobox_with_description import QComboBoxWithDescription
 from .ensemble_experiment_panel import EnsembleExperimentPanel
+from .ensemble_information_filter_panel import EnsembleInformationFilterPanel
 from .ensemble_smoother_panel import EnsembleSmootherPanel
 from .evaluate_ensemble_panel import EvaluateEnsemblePanel
 from .experiment_config_panel import ExperimentConfigPanel
@@ -174,6 +175,12 @@ def __init__(
             EnsembleSmootherPanel(analysis_config, run_path, notifier, ensemble_size),
             experiment_type_valid,
         )
+        self.addExperimentConfigPanel(
+            EnsembleInformationFilterPanel(
+                analysis_config, run_path, notifier, ensemble_size
+            ),
+            experiment_type_valid,
+        )
         self.addExperimentConfigPanel(
             ManualUpdatePanel(ensemble_size, run_path, notifier, analysis_config),
             experiment_type_valid,

tests/ert/ui_tests/gui/test_main_window.py

@@ -53,6 +53,7 @@
 from ert.plugins import ErtPluginManager
 from ert.run_models import (
     EnsembleExperiment,
+    EnsembleInformationFilter,
     EnsembleSmoother,
     MultipleDataAssimilation,
     SingleTestRun,
@@ -111,7 +112,7 @@ def test_that_the_ui_show_no_errors_and_enables_update_for_poly_example(qapp):
     with add_gui_log_handler() as log_handler:
         gui, *_ = ert.gui.main._start_initial_gui_window(args, log_handler)
         combo_box = get_child(gui, QComboBox, name="experiment_type")
-        assert combo_box.count() == 6
+        assert combo_box.count() == 7
 
         for i in range(combo_box.count()):
             assert combo_box.model().item(i).isEnabled()
@@ -131,7 +132,7 @@ def test_gui_shows_a_warning_and_disables_update_when_there_are_no_observations(
     with add_gui_log_handler() as log_handler:
         gui, *_ = ert.gui.main._start_initial_gui_window(args, log_handler)
         combo_box = get_child(gui, QComboBox, name="experiment_type")
-        assert combo_box.count() == 6
+        assert combo_box.count() == 7
 
         for i in range(3):
             assert combo_box.model().item(i).isEnabled()
@@ -159,7 +160,7 @@ def test_gui_shows_a_warning_and_disables_update_when_parameters_are_missing(
     with add_gui_log_handler() as log_handler:
         gui, *_ = ert.gui.main._start_initial_gui_window(args, log_handler)
         combo_box = get_child(gui, QComboBox, name="experiment_type")
-        assert combo_box.count() == 6
+        assert combo_box.count() == 7
 
         for i in range(3):
             assert combo_box.model().item(i).isEnabled()
@@ -699,7 +700,7 @@ def test_that_es_mda_restart_run_box_is_disabled_when_there_are_no_cases(qtbot):
 
     combo_box = get_child(gui, QComboBox, name="experiment_type")
     qtbot.mouseClick(combo_box, Qt.MouseButton.LeftButton)
-    assert combo_box.count() == 6
+    assert combo_box.count() == 7
     combo_box.setCurrentIndex(3)
 
     assert combo_box.currentText() == MultipleDataAssimilation.display_name()
@@ -749,6 +750,7 @@ def test_validation_of_experiment_names_in_run_models(
     experiment_types_to_test = (
         (EnsembleExperiment.display_name(), "Ensemble_experiment_panel"),
         (EnsembleSmoother.display_name(), "ensemble_smoother_panel"),
+        (EnsembleInformationFilter.display_name(), "enif_panel"),
         (
             MultipleDataAssimilation.display_name(),
             "ES_MDA_panel",