Clean up and organize dashboard code (#830)

* Organize main toolbar file

* Separate simulation logic from Analyze section

* cleanup dashboard file import code

Author: proy30

src/python/impactx/dashboard/Analyze/plotsMain.py

@@ -6,15 +6,11 @@
 License: BSD-3-Clause-LBNL
 """
 
-import asyncio
 import glob
-import io
 import os
 
 from trame.widgets import matplotlib, plotly, vuetify
-from wurlitzer import pipes
 
-from ..simulation import run_simulation
 from ..trame_setup import setup_server
 from .analyzeFunctions import AnalyzeFunctions
 from .plot_ParameterEvolutionOverS.overS import line_plot_1d
@@ -137,24 +133,6 @@ def update_plot():
         state.show_table = False
 
 
-def run_simulation_impactX():
-    buf = io.StringIO()
-
-    with pipes(stdout=buf, stderr=buf):
-        run_simulation()
-
-    buf.seek(0)
-    lines = [line.strip() for line in buf.getvalue().splitlines()]
-
-    # Use $nextTick to ensure the terminal is fully rendered before printing
-    async def print_lines():
-        for line in lines:
-            ctrl.terminal_print(line)
-        ctrl.terminal_print("Simulation complete.")
-
-    asyncio.create_task(print_lines())
-
-
 # -----------------------------------------------------------------------------
 # State changes
 # -----------------------------------------------------------------------------
@@ -173,14 +151,6 @@ def on_filtered_data_change(**kwargs):
     update_plot()
 
 
-@ctrl.add("run_simulation")
-def run_simulation_and_store():
-    state.plot_options = available_plot_options(simulationClicked=True)
-    run_simulation_impactX()
-    update_plot()
-    load_dataTable_data()
-
-
 # -----------------------------------------------------------------------------
 # GUI
 # -----------------------------------------------------------------------------

src/python/impactx/dashboard/Run/__init__.py

@@ -0,0 +1,27 @@
+import asyncio
+import io
+
+from wurlitzer import pipes
+
+from ..simulation import run_simulation
+from ..trame_setup import setup_server
+
+server, state, ctrl = setup_server()
+
+
+def execute_impactx_sim():
+    buf = io.StringIO()
+
+    with pipes(stdout=buf, stderr=buf):
+        run_simulation()
+
+    buf.seek(0)
+    lines = [line.strip() for line in buf.getvalue().splitlines()]
+
+    # Use $nextTick to ensure the terminal is fully rendered before printing
+    async def print_lines():
+        for line in lines:
+            ctrl.terminal_print(line)
+        ctrl.terminal_print("Simulation complete.")
+
+    asyncio.create_task(print_lines())

src/python/impactx/dashboard/Run/controls.py

@@ -8,7 +8,9 @@
 
 from trame.widgets import html, vuetify
 
+from ..Analyze.plotsMain import available_plot_options, load_dataTable_data, update_plot
 from ..Input.generalFunctions import generalFunctions
+from ..Run.controls import execute_impactx_sim
 from ..trame_setup import setup_server
 from .exportTemplate import input_file
 from .importParser import DashboardParser
@@ -22,54 +24,53 @@
 state.importing_file = False
 
 
-# -----------------------------------------------------------------------------
-# Triggers/Controllers
-# -----------------------------------------------------------------------------
-def reset_importing_states():
-    state.import_file_error = None
-    state.import_file_details = None
-    state.import_file = None
-    state.importing_file = False
-
-
-@ctrl.add("reset_all")
-def reset_all():
-    reset_importing_states()
-    generalFunctions.reset_inputs("all")
-
-
-@ctrl.trigger("export")
-def on_export_click():
-    return input_file()
-
-
-@state.change("import_file")
-def on_import_file_change(import_file, **kwargs):
-    if import_file:
-        try:
-            state.importing_file = True
-            DashboardParser.file_details(import_file)
-            DashboardParser.populate_impactx_simulation_file_to_ui(import_file)
-        except Exception:
-            state.import_file_error = True
-            state.import_file_error_message = "Unable to parse"
-        finally:
-            state.importing_file = False
+class ToolbarImport:
+    @state.change("import_file")
+    def on_import_file_change(import_file, **kwargs):
+        if import_file:
+            try:
+                state.importing_file = True
+                DashboardParser.file_details(import_file)
+                DashboardParser.populate_impactx_simulation_file_to_ui(import_file)
+            except Exception:
+                state.import_file_error = True
+                state.import_file_error_message = "Unable to parse"
+            finally:
+                state.importing_file = False
 
+    @staticmethod
+    def reset_importing_states():
+        """
+        Resets import related states to default.
+        """
 
-# -----------------------------------------------------------------------------
-# Common toolbar elements
-# -----------------------------------------------------------------------------
+        state.import_file_error = None
+        state.import_file_details = None
+        state.import_file = None
+        state.importing_file = False
 
 
-class ToolbarElements:
+class InputToolbar:
     """
-    Helper functions to create
-    Vuetify UI elements for toolbar.
+    Contains toolbar elements for the Input page.
     """
 
+    @ctrl.trigger("export")
+    def on_export_click():
+        return input_file()
+
+    @ctrl.add("reset_all")
+    def reset_all():
+        ToolbarImport.reset_importing_states()
+        generalFunctions.reset_inputs("all")
+
     @staticmethod
-    def export_button():
+    def export_button() -> vuetify.VBtn:
+        """
+        Creates an export button to download a .py file
+        containing the user's current input values.
+        """
+
         with vuetify.VBtn(
             click="utils.download('impactx_simulation.py', trigger('export'), 'text/plain')",
             outlined=True,
@@ -81,28 +82,12 @@ def export_button():
             html.Span("Export")
 
     @staticmethod
-    def plot_options():
-        vuetify.VSelect(
-            v_model=("active_plot", "1D plots over s"),
-            items=("plot_options",),
-            label="Select plot to view",
-            hide_details=True,
-            dense=True,
-            style="max-width: 250px",
-            disabled=("disableRunSimulationButton", True),
-        )
-
-    @staticmethod
-    def run_simulation_button():
-        vuetify.VBtn(
-            "Run Simulation",
-            style="background-color: #00313C; color: white; margin: 0 20px;",
-            click=ctrl.run_simulation,
-            disabled=("disableRunSimulationButton", True),
-        )
+    def import_button() -> None:
+        """
+        Displays the 'import' button on the input section
+        of the dashboard.
+        """
 
-    @staticmethod
-    def import_button():
         vuetify.VFileInput(
             v_model=("import_file",),
             accept=".py",
@@ -146,7 +131,12 @@ def import_button():
                 )
 
     @staticmethod
-    def reset_inputs_button():
+    def reset_inputs_button() -> vuetify.VBtn:
+        """
+        Creates a button to reset all input fields to
+        default values.
+        """
+
         with vuetify.VBtn(
             click=ctrl.reset_all,
             outlined=True,
@@ -155,43 +145,103 @@ def reset_inputs_button():
             vuetify.VIcon("mdi-refresh", left=True)
             html.Span("Reset")
 
+
+class RunToolbar:
+    """
+    Contains toolbar elements for the Run page.
+    """
+
+    @ctrl.add("begin_sim")
+    def run():
+        state.plot_options = available_plot_options(simulationClicked=True)
+        execute_impactx_sim()
+        update_plot()
+        load_dataTable_data()
+
     @staticmethod
-    def dashboard_info():
+    def run_simulation_button() -> vuetify.VBtn:
         """
-        Creates an alert box with dashboard information.
+        Creates a button to run an ImpactX simulation
+        with the current user-provided inputs.
         """
 
-        vuetify.VAlert(
-            "ImpactX Dashboard is provided as a preview and continues to be developed. "
-            "Thus, it may not yet include all the features available in ImpactX.",
-            type="info",
+        return vuetify.VBtn(
+            "Run Simulation",
+            style="background-color: #00313C; color: white; margin: 0 20px;",
+            click=ctrl.begin_sim,
+            disabled=("disableRunSimulationButton", True),
+        )
+
+
+class AnalyzeToolbar:
+    """
+    Contains toolbar elements for the Analyze page.
+    """
+
+    @staticmethod
+    def plot_options() -> vuetify.VSelect:
+        """
+        Creates a dropdown menu for selecting a plot
+        to visualize simulation results.
+        """
+
+        return vuetify.VSelect(
+            v_model=("active_plot", "1D plots over s"),
+            items=("plot_options",),
+            label="Select plot to view",
+            hide_details=True,
             dense=True,
-            dismissible=True,
-            v_model=("show_dashboard_alert", True),
-            classes="mt-4",
+            style="max-width: 250px",
+            disabled=("disableRunSimulationButton", True),
         )
 
 
-class Toolbars:
+class GeneralToolbar:
     """
-    Builds toolbar for dashboard.
+    General tolbar elements.
     """
 
     @staticmethod
     def dashboard_toolbar(toolbar_name: str) -> None:
+        """
+        Builds and displays the appropriate toolbar
+        based on the selected dashboard section.
+
+        :param toolbar_name: The name of the dashboard section
+        for which the toolbar is needed.
+        """
+
         toolbar_name = toolbar_name.lower()
         if toolbar_name == "input":
-            (ToolbarElements.dashboard_info(),)
+            (GeneralToolbar.dashboard_info(),)
             vuetify.VSpacer()
-            ToolbarElements.import_button()
-            ToolbarElements.export_button()
-            ToolbarElements.reset_inputs_button()
-
+            InputToolbar.import_button()
+            InputToolbar.export_button()
+            InputToolbar.reset_inputs_button()
         elif toolbar_name == "run":
-            (ToolbarElements.dashboard_info(),)
+            (GeneralToolbar.dashboard_info(),)
             (vuetify.VSpacer(),)
-            (ToolbarElements.run_simulation_button(),)
+            (RunToolbar.run_simulation_button(),)
         elif toolbar_name == "analyze":
-            (ToolbarElements.dashboard_info(),)
+            (GeneralToolbar.dashboard_info(),)
             vuetify.VSpacer()
-            ToolbarElements.plot_options()
+            AnalyzeToolbar.plot_options()
+
+    @staticmethod
+    def dashboard_info() -> vuetify.VAlert:
+        """
+        Creates an informational alert box for the dashboard to
+        notify users that the ImpactX dashboard is still in development.
+
+        :return: A Vuetify alert component displaying the dashboard notice.
+        """
+
+        return vuetify.VAlert(
+            "ImpactX Dashboard is provided as a preview and continues to be developed. "
+            "Thus, it may not yet include all the features available in ImpactX.",
+            type="info",
+            dense=True,
+            dismissible=True,
+            v_model=("show_dashboard_alert", True),
+            classes="mt-4",
+        )

src/python/impactx/dashboard/Toolbar/toolbarMain.py renamed to src/python/impactx/dashboard/Toolbar/controls.py

@@ -20,7 +20,7 @@
 from .Input.latticeConfiguration.latticeMain import LatticeConfiguration
 from .Input.space_charge_configuration.spaceChargeMain import SpaceChargeConfiguration
 from .start import main
-from .Toolbar.toolbarMain import Toolbars
+from .Toolbar.controls import GeneralToolbar
 from .trame_setup import setup_server
 
 server, state, ctrl = setup_server()
@@ -72,11 +72,11 @@ def application():
         layout.title.hide()
         with layout.toolbar:
             with vuetify.Template(v_if="$route.path == '/Analyze'"):
-                Toolbars.dashboard_toolbar("analyze")
+                GeneralToolbar.dashboard_toolbar("analyze")
             with vuetify.Template(v_if="$route.path == '/Input'"):
-                Toolbars.dashboard_toolbar("input")
+                GeneralToolbar.dashboard_toolbar("input")
             with vuetify.Template(v_if="$route.path == '/Run'"):
-                Toolbars.dashboard_toolbar("run")
+                GeneralToolbar.dashboard_toolbar("run")
 
         with layout.drawer as drawer:
             drawer.width = 200