add nice mode helper params, and allow users to change reference current

Author: SBlokhuizen

waveform_editor/gui/shape_editor.py

@@ -62,10 +62,7 @@ def __init__(self):
         button_start.disabled = (
             (
                 self.plasma_shape.param.has_shape.rx.not_()
-                & (
-                    self.nice_settings.param.mode.rx()
-                    == self.nice_settings.INVERSE_MODE
-                )
+                & self.nice_settings.param.is_inverse_mode.rx()
             )
             | self.plasma_properties.param.has_properties.rx.not_()
             | self.nice_settings.param.are_required_filled.rx.not_()
@@ -88,8 +85,7 @@ def __init__(self):
                 self.plasma_shape,
                 "Plasma Shape",
                 is_valid=self.plasma_shape.param.has_shape,
-                visible=self.nice_settings.param.mode.rx()
-                == self.nice_settings.INVERSE_MODE,
+                visible=self.nice_settings.param.is_inverse_mode.rx(),
             ),
             self._create_card(
                 pn.Column(self.plasma_properties, self.nice_plotter.profiles_pane),
@@ -191,7 +187,7 @@ def _create_equilibrium(self):
         equilibrium.vacuum_toroidal_field.b0.resize(1)
 
         # Only fill plasma shape for NICE inverse mode
-        if self.nice_settings.mode == self.nice_settings.INVERSE_MODE:
+        if self.nice_settings.is_inverse_mode:
             equilibrium.time_slice[0].boundary.outline.r = self.plasma_shape.outline_r
             equilibrium.time_slice[0].boundary.outline.z = self.plasma_shape.outline_z
 
@@ -216,7 +212,7 @@ async def submit(self, event=None):
         description IDSs and an input equilibrium IDS."""
 
         self.coil_currents.fill_pf_active(self.pf_active)
-        if self.nice_settings.mode == self.nice_settings.DIRECT_MODE:
+        if self.nice_settings.is_direct_mode:
             xml_params = self.xml_params_dir
         else:
             xml_params = self.xml_params_inv
@@ -227,9 +223,7 @@ async def submit(self, event=None):
         equilibrium = self._create_equilibrium()
         if not self.communicator.running:
             await self.communicator.run(
-                is_direct_mode=(
-                    self.nice_settings.mode == self.nice_settings.DIRECT_MODE
-                )
+                is_direct_mode=self.nice_settings.is_direct_mode
             )
         await self.communicator.submit(
             ET.tostring(xml_params, encoding="unicode"),

waveform_editor/settings.py

@@ -47,6 +47,17 @@ class NiceSettings(param.Parameterized):
         objects=[INVERSE_MODE, DIRECT_MODE], default=INVERSE_MODE, precedence=-1
     )
     are_required_filled = param.Boolean(precedence=-1)
+    is_direct_mode = param.Boolean(precedence=-1)
+    is_inverse_mode = param.Boolean(precedence=-1)
+
+    @param.depends("mode", watch=True, on_init=True)
+    def set_mode_flags(self):
+        if self.mode == self.INVERSE_MODE:
+            self.is_direct_mode = False
+            self.is_inverse_mode = True
+        else:
+            self.is_direct_mode = True
+            self.is_inverse_mode = False
 
     @param.depends(
         *BASE_REQUIRED, "inv_executable", "dir_executable", "mode", watch=True
@@ -72,8 +83,14 @@ def apply_settings(self, params):
         self.param.update(**params)
 
     def to_dict(self):
-        """Returns a dictionary representation of current parameter values."""
-        return {p: getattr(self, p) for p in self.param if p != "name"}
+        """Returns a dictionary representation of current parameter values, excluding
+        params with a precendence of -1."""
+        result = {}
+        for p in self.param:
+            param_obj = self.param[p]
+            if p != "name" and param_obj.precedence != -1:
+                result[p] = getattr(self, p)
+        return result
 
     def panel(self):
         items = []
@@ -83,8 +100,8 @@ def panel(self):
                 continue
 
             # Add warning indicator if required parameter is not filled
-            is_inv_required = p == "inv_executable" and self.mode == self.INVERSE_MODE
-            is_dir_required = p == "dir_executable" and self.mode == self.DIRECT_MODE
+            is_inv_required = p == "inv_executable" and self.is_inverse_mode
+            is_dir_required = p == "dir_executable" and self.is_direct_mode
             is_base_required = p in self.BASE_REQUIRED
 
             row_content = [pn.Param(self.param[p], show_name=False)]

waveform_editor/shape_editor/coil_currents.py

@@ -49,19 +49,13 @@ def create_ui(self, pf_active):
             coil_current = coil.current
             checkbox = pn.widgets.Checkbox(
                 margin=(30, 10, 10, 10),
-                disabled=self.nice_settings.param.mode.rx()
-                == self.nice_settings.DIRECT_MODE,
+                disabled=self.nice_settings.param.is_direct_mode.rx(),
             )
             slider = pn.widgets.EditableFloatSlider(
                 name=f"{coil.name} Current [{coil_current.metadata.units}]",
                 value=coil_current.data[0] if coil_current.data.has_value else 0.0,
                 start=-5e4,
                 end=5e4,
-                disabled=checkbox.param.value.rx.not_()
-                & (
-                    self.nice_settings.param.mode.rx()
-                    == self.nice_settings.INVERSE_MODE
-                ),
                 format="0",
                 width=450,
             )
@@ -78,12 +72,8 @@ def fill_pf_active(self, pf_active):
             pf_active: pf_active IDS to update the coil currents for.
         """
         for i, coil_ui in enumerate(self.coil_ui):
-            checkbox, slider = coil_ui.objects
-            if (
-                checkbox.value
-                or self.nice_settings.mode == self.nice_settings.DIRECT_MODE
-            ):
-                pf_active.coil[i].current.data = np.array([slider.value])
+            _, slider = coil_ui.objects
+            pf_active.coil[i].current.data = np.array([slider.value])
 
     def sync_ui_with_pf_active(self, pf_active):
         """Synchronize UI sliders with the current values from the pf_active IDS.

waveform_editor/shape_editor/nice_integration.py

@@ -151,16 +151,11 @@ async def run(self, is_direct_mode=False):
 
         self.xml_config_file = tempfile.NamedTemporaryFile()  # noqa: SIM115
 
-        # Select configuration based on mode
-        config_str = (
-            _muscle3_dir_configuration if is_direct_mode else _muscle3_inv_configuration
-        )
-
         # MUSCLE manager
         self.manager_pipe, pipe = multiprocessing.Pipe()
         self.manager = multiprocessing.Process(
             target=run_muscle_manager,
-            args=[pipe, self.xml_config_file.name, config_str],
+            args=[pipe, self.xml_config_file.name, is_direct_mode],
             name="MUSCLE Manager",
         )
         self.manager.start()
@@ -346,9 +341,12 @@ def run_muscle3_communicator(
 
 
 def run_muscle_manager(
-    pipe: multiprocessing.connection.Connection, xml_path: str, config_str: str
+    pipe: multiprocessing.connection.Connection, xml_path: str, is_direct_mode: bool
 ):
     """Run the muscle_manager with a given configuration."""
+    config_str = (
+        _muscle3_dir_configuration if is_direct_mode else _muscle3_inv_configuration
+    )
     config = ymmsl.load(config_str.format(xml_path=xml_path))
     manager = Manager(config)
     server_location = manager.get_server_location()

waveform_editor/shape_editor/nice_plotter.py

@@ -94,8 +94,7 @@ def __init__(self, **params):
             show_name=False,
             widgets={
                 "show_desired_shape": {
-                    "visible": self.nice_settings.param.mode.rx()
-                    == self.nice_settings.INVERSE_MODE
+                    "visible": self.nice_settings.param.is_inverse_mode.rx()
                 }
             },
         )
@@ -138,7 +137,7 @@ def _plot_profiles(self):
     )
     def _plot_plasma_shape(self):
         if (
-            self.nice_settings.mode == self.nice_settings.DIRECT_MODE
+            self.nice_settings.is_direct_mode
             or not self.show_desired_shape
             or not self.plasma_shape.has_shape
         ):