feat: add toggle between two-sim and multi-sim modes

Author: willdunklin

src/e3sm_compareview/app.py

@@ -17,6 +17,8 @@
     build_simulation_configs,
     comparison_signature_for,
     label_signature_for,
+    normalize_comparison_mode,
+    normalize_two_sim_target,
 )
 from e3sm_compareview.components import doc, drawers, file_browser, toolbars
 from e3sm_compareview.pipeline import EAMVisSource
@@ -65,7 +67,10 @@ def __init__(self, server=None):
                 # Simulation comparison selection
                 "simulation_configs": [],
                 "control_simulation_file": "",
-                "comparison_mode": "diff",
+                "two_sim_test_simulation_file": "",
+                "comparison_mode": "multi-sim",
+                "comparison_type": "diff",
+                "selected_columns": ["ctrl", "test", "diff", "comp1", "comp2"],
                 "dragged_simulation_path": "",
             }
         )
@@ -257,9 +262,24 @@ def selected_variable_names(self):
     @property
     def active_simulation_configs(self):
         return active_simulation_configs(
-            self.state.simulation_configs, self.state.control_simulation_file
+            self.state.simulation_configs,
+            self.state.control_simulation_file,
+            self.state.comparison_mode,
+            self.state.two_sim_test_simulation_file,
         )
 
+    def _ensure_two_sim_target(self):
+        if self.state.comparison_mode != "two-sim":
+            return
+
+        target_path = normalize_two_sim_target(
+            self.state.simulation_configs,
+            self.state.control_simulation_file,
+            self.state.two_sim_test_simulation_file,
+        )
+        if target_path != self.state.two_sim_test_simulation_file:
+            self.state.two_sim_test_simulation_file = target_path
+
     def _selected_variables_to_show(self):
         vars_to_show = self.selected_variables
         return vars_to_show if any(vars_to_show.values()) else None
@@ -338,7 +358,10 @@ def download_state(self):
         }
         state_content["comparisons"] = {
             "control": self.state.control_simulation_file,
+            "target": self.state.two_sim_test_simulation_file,
             "mode": self.state.comparison_mode,
+            "type": self.state.comparison_type,
+            "columns": self.state.selected_columns,
             "simulations": self.state.simulation_configs,
         }
         state_content["variables-selection"] = self.state.variables_selected
@@ -364,7 +387,10 @@ def download_state(self):
         for view_type, var_names in active_variables.items():
             for var_name in var_names:
                 for view_spec in self.source.get_view_specs(
-                    var_name, self.state.comparison_mode
+                    var_name,
+                    self.state.comparison_mode,
+                    self.state.comparison_type,
+                    self.state.selected_columns,
                 ):
                     config = self.view_manager.get_view(view_spec, view_type).config
                     views_to_export.append(
@@ -430,7 +456,28 @@ async def _import_state(self, state_content):
             self.state.control_simulation_file = comparisons.get(
                 "control", self.state.control_simulation_file
             )
-            self.state.comparison_mode = comparisons.get("mode", "diff")
+            self.state.two_sim_test_simulation_file = comparisons.get(
+                "target", self.state.two_sim_test_simulation_file
+            )
+            raw_mode = comparisons.get("mode")
+            if raw_mode in ("two-sim", "multi-sim"):
+                self.state.comparison_mode = raw_mode
+            else:
+                self.state.comparison_mode = comparisons.get(
+                    "strategy", self.state.comparison_mode
+                )
+
+            raw_type = comparisons.get("type")
+            if raw_type in ("diff", "comp1", "comp2"):
+                self.state.comparison_type = raw_type
+            else:
+                legacy_type = comparisons.get("mode")
+                if legacy_type in ("diff", "comp1", "comp2"):
+                    self.state.comparison_type = legacy_type
+            self.state.selected_columns = comparisons.get(
+                "columns", self.state.selected_columns
+            )
+            self._ensure_two_sim_target()
 
         # Load variables
         self.state.variables_selected = state_content["variables-selection"]
@@ -477,6 +524,7 @@ async def data_loading_open(self, simulation_files, connectivity):
         )
         self.state.simulation_configs = simulation_configs
         self.state.control_simulation_file = control_file
+        self._ensure_two_sim_target()
 
         await asyncio.sleep(0.1)
         # Use the selected simulations from the UI state.
@@ -584,21 +632,52 @@ async def _data_load_variables(self):
     def _on_layout_change(self, **_):
         self._rebuild_active_layout()
 
+    @change("comparison_type")
+    def _on_comparison_type_change(self, **_):
+        if (
+            self.state.comparison_mode != "multi-sim"
+            or not self.state.variables_loaded
+        ):
+            return
+
+        self._rebuild_active_layout(update_color=True)
+
     @change("comparison_mode")
-    def _on_comparison_mode_change(self, **_):
-        if not self.state.variables_loaded:
+    def _on_comparison_mode_change(self, comparison_mode, **_):
+        normalized = normalize_comparison_mode(comparison_mode)
+        if normalized != comparison_mode:
+            self.state.comparison_mode = normalized
             return
 
+        self.state.variables_selected = []
+        self.state.variables_loaded = False
+
+    @change("selected_columns")
+    def _on_selected_columns_change(self, **_):
+        if (
+            self.state.comparison_mode != "two-sim"
+            or not self.state.variables_loaded
+        ):
+            return
         self._rebuild_active_layout(update_color=True)
 
-    @change("simulation_configs", "control_simulation_file")
+    @change(
+        "simulation_configs",
+        "control_simulation_file",
+        "comparison_mode",
+        "two_sim_test_simulation_file",
+    )
     def _on_simulation_selection_change(self, simulation_configs, **_):
         if simulation_configs:
             valid_paths = {entry["path"] for entry in simulation_configs}
             if self.state.control_simulation_file not in valid_paths:
                 self.state.control_simulation_file = simulation_configs[0]["path"]
+            self._ensure_two_sim_target()
         comparison_signature = comparison_signature_for(
-            simulation_configs, self.state.control_simulation_file
+            simulation_configs,
+            self.state.control_simulation_file,
+            self.state.comparison_mode,
+            self.state.two_sim_test_simulation_file,
         )
         label_signature = label_signature_for(simulation_configs)
 
@@ -610,6 +689,7 @@ def _on_simulation_selection_change(self, simulation_configs, **_):
 
         if comparison_changed:
             self._refresh_source_simulations()
+            self.view_manager.reset_view_orders(self.selected_variables)
             if self.state.variables_loaded and self._rebuild_active_layout(update_color=True):
                 return
             self.state.variables_loaded = False

src/e3sm_compareview/comparison.py

@@ -1,7 +1,14 @@
 import re
 from pathlib import Path
 
-COMPARISON_MODES = ("diff", "comp1", "comp2")
+COMPARISON_TYPES = ("diff", "comp1", "comp2")
+COMPARISON_MODES = ("two-sim", "multi-sim")
+
+
+def normalize_comparison_mode(mode):
+    if mode in COMPARISON_MODES:
+        return mode
+    return "multi-sim"
 
 
 def default_simulation_label(file_path):
@@ -71,9 +78,33 @@ def build_simulation_configs(simulation_files, existing_configs, control_file):
     return configs, control_file
 
 
-def comparison_signature_for(configs, control_file):
+def normalize_two_sim_target(configs, control_file, two_sim_target_file):
+    configs = configs or []
+    if not configs:
+        return ""
+
+    valid_paths = [entry.get("path") for entry in configs if entry.get("path")]
+    if not valid_paths:
+        return ""
+
+    if two_sim_target_file in valid_paths and two_sim_target_file != control_file:
+        return two_sim_target_file
+
+    for path in valid_paths:
+        if path != control_file:
+            return path
+
+    return control_file
+
+
+def comparison_signature_for(
+    configs, control_file, comparison_mode="multi-sim", two_sim_target_file=""
+):
+    comparison_mode = normalize_comparison_mode(comparison_mode)
     return (
+        comparison_mode,
         control_file,
+        normalize_two_sim_target(configs, control_file, two_sim_target_file),
         tuple(
             (entry.get("path"), bool(entry.get("include", True)))
             for entry in (configs or [])
@@ -87,7 +118,10 @@ def label_signature_for(configs):
     )
 
 
-def active_simulation_configs(configs, control_file):
+def active_simulation_configs(
+    configs, control_file, comparison_mode="multi-sim", two_sim_target_file=""
+):
+    comparison_mode = normalize_comparison_mode(comparison_mode)
     configs = configs or []
     if not configs:
         return []
@@ -96,11 +130,35 @@ def active_simulation_configs(configs, control_file):
     control_file = control_file or configs[0]["path"]
     control_config = configs_by_path.get(control_file, configs[0])
     control_index = next(
-        (index for index, entry in enumerate(configs) if entry["path"] == control_config["path"]),
+        (
+            index
+            for index, entry in enumerate(configs)
+            if entry["path"] == control_config["path"]
+        ),
         0,
     )
 
     active = [{**control_config, "role": "control", "source_index": control_index}]
+
+    if comparison_mode == "two-sim":
+        target_path = normalize_two_sim_target(
+            configs, control_config["path"], two_sim_target_file
+        )
+        target_config = configs_by_path.get(target_path)
+        if target_config and target_config["path"] != control_config["path"]:
+            target_index = next(
+                (
+                    index
+                    for index, entry in enumerate(configs)
+                    if entry["path"] == target_config["path"]
+                ),
+                0,
+            )
+            active.append(
+                {**target_config, "role": "comparison", "source_index": target_index}
+            )
+        return active
+
     active.extend(
         {**entry, "role": "comparison", "source_index": index}
         for index, entry in enumerate(configs)

src/e3sm_compareview/components/simulation_selection.py

@@ -70,6 +70,15 @@ def __init__(self):
                         "{{ simulation_configs.length }} loaded",
                         classes="text-caption mr-4",
                     )
+                with html.Div(classes="px-3 py-2 border-b-thin"):
+                    with v3.VBtnToggle(
+                        v_model=("comparison_mode", "multi-sim"),
+                        mandatory=True,
+                        density="compact",
+                        divided=True,
+                    ):
+                        v3.VBtn("Two Sim", value="two-sim", classes="text-none")
+                        v3.VBtn("Multi Sim", value="multi-sim", classes="text-none")
 
                 with html.Div(v_if="simulation_configs.length === 0", classes="pa-4"):
                     html.Div(
@@ -113,7 +122,7 @@ def __init__(self):
                                             update_modelValue="""
 simulation_configs = simulation_configs.map((sim) =>
   sim.path === entry.path ? ({ ...sim, label: $event }) : sim
-)
+);
 """,
                                             label="Label",
                                             density="compact",
@@ -132,30 +141,68 @@ def __init__(self):
                                                 "control_simulation_file === entry.path ? 'primary' : 'default'",
                                             ),
                                             classes="text-none w-100",
-                                            style="min-width: 100px;",
+                                            style="min-width: 112px;",
                                             size="small",
-                                            click="control_simulation_file = entry.path",
+                                            click=(
+                                                self._on_control_selected,
+                                                "[entry.path]",
+                                            ),
                                         )
                                     with v3.VCol(cols=6, md=3):
-                                        v3.VCheckbox(
-                                            model_value=(
-                                                "control_simulation_file === entry.path ? true : entry.include",
-                                            ),
-                                            update_modelValue="""
+                                        with v3.Template(v_if="comparison_mode === 'multi-sim'"):
+                                            v3.VCheckbox(
+                                                model_value=(
+                                                    "control_simulation_file === entry.path ? true : entry.include",
+                                                ),
+                                                update_modelValue="""
 simulation_configs = simulation_configs.map((sim) =>
   sim.path === entry.path ? ({ ...sim, include: !!$event }) : sim
-)
+);
 """,
-                                            label="Include",
-                                            density="compact",
-                                            hide_details=True,
-                                            disabled=(
-                                                "control_simulation_file === entry.path",
-                                            ),
-                                        )
+                                                label="Include",
+                                                density="compact",
+                                                hide_details=True,
+                                                disabled=(
+                                                    "control_simulation_file === entry.path",
+                                                ),
+                                            )
+                                        with v3.Template(v_else=True):
+                                            v3.VBtn(
+                                                text=(
+                                                    "two_sim_test_simulation_file === entry.path ? 'Test' : 'Set test'",
+                                                ),
+                                                variant=(
+                                                    "two_sim_test_simulation_file === entry.path ? 'flat' : 'outlined'",
+                                                ),
+                                                color=(
+                                                    "two_sim_test_simulation_file === entry.path ? 'primary' : 'default'",
+                                                ),
+                                                classes="text-none w-100",
+                                                style="min-width: 112px;",
+                                                size="small",
+                                                disabled=(
+                                                    "control_simulation_file === entry.path",
+                                                ),
+                                                click="two_sim_test_simulation_file = entry.path",
+                                            )
                                 html.Div(
                                     "{{ entry.path }}",
                                     classes="text-caption text-medium-emphasis mt-2",
                                     style="overflow: hidden; text-overflow: ellipsis; white-space: nowrap; direction: rtl; text-align: left;",
                                     title=("entry.path",),
                                 )
+
+    def _on_control_selected(self, control_path, **_):
+        self.state.control_simulation_file = control_path
+        if self.state.comparison_mode != "two-sim":
+            return
+        if self.state.two_sim_test_simulation_file != control_path:
+            return
+
+        fallback = control_path
+        for sim in self.state.simulation_configs or []:
+            sim_path = sim.get("path")
+            if sim_path and sim_path != control_path:
+                fallback = sim_path
+                break
+        self.state.two_sim_test_simulation_file = fallback