Condense repetitive dashboard code

src/python/impactx/dashboard/Input/csrConfiguration/csrMain.py

@@ -1,5 +1,6 @@
 from trame.widgets import vuetify
 
+from ...Input.trameFunctions import TrameFunctions
 from ...trame_setup import setup_server
 from ..generalFunctions import generalFunctions
 
@@ -37,32 +38,16 @@ def card():
         """
 
         with vuetify.VCard(v_show="csr", style="width: 170px;"):
-            with vuetify.VCardTitle("CSR"):
-                vuetify.VSpacer()
-                vuetify.VIcon(
-                    "mdi-information",
-                    classes="ml-2",
-                    click=lambda: generalFunctions.documentation("CSR"),
-                    style="color: #00313C;",
-                )
-            vuetify.VDivider()
+            TrameFunctions.input_section_header("CSR")
             with vuetify.VCardText():
                 with vuetify.VRow(classes="my-0"):
                     with vuetify.VCol(classes="py-0"):
-                        vuetify.VSelect(
+                        TrameFunctions.select(
                             label="Particle Shape",
-                            v_model=("particle_shape",),
-                            items=([1, 2, 3],),
-                            dense=True,
+                            v_model_name="particle_shape",
                         )
                 with vuetify.VRow(classes="my-0"):
                     with vuetify.VCol(classes="py-0"):
-                        vuetify.VTextField(
-                            label="CSR Bins",
-                            v_model=("csr_bins",),
-                            error_messages=("csr_bins_error_message",),
-                            type="number",
-                            dense=True,
-                            step=generalFunctions.get_default("csr_bins", "steps"),
-                            __properties=["step"],
+                        TrameFunctions.text_field(
+                            label="CSR Bins", v_model_name="csr_bins"
                         )

src/python/impactx/dashboard/Input/distributionParameters/distributionMain.py

@@ -13,6 +13,7 @@
 
 from impactx import distribution
 
+from ...Input.trameFunctions import TrameFunctions
 from ...trame_setup import setup_server
 from ..generalFunctions import generalFunctions
 from .distributionFunctions import DistributionFunctions
@@ -191,33 +192,24 @@ def card():
         """
 
         with vuetify.VCard(style="width: 340px; height: 300px"):
-            with vuetify.VCardTitle("Distribution Parameters"):
-                vuetify.VSpacer()
-                vuetify.VIcon(
-                    "mdi-information",
-                    style="color: #00313C;",
-                    click=lambda: generalFunctions.documentation("BeamDistributions"),
-                )
-            vuetify.VDivider()
+            TrameFunctions.input_section_header("Distribution Parameters")
             with vuetify.VCardText():
                 with vuetify.VRow():
                     with vuetify.VCol(cols=6):
-                        vuetify.VCombobox(
+                        TrameFunctions.select(
                             label="Select Distribution",
-                            v_model=("selectedDistribution",),
+                            v_model_name="selectedDistribution",
                             items=("listOfDistributions",),
-                            dense=True,
                         )
                     with vuetify.VCol(cols=6):
-                        vuetify.VSelect(
-                            v_model=("selectedDistributionType",),
+                        TrameFunctions.select(
                             label="Type",
+                            v_model_name="selectedDistributionType",
                             items=(
                                 generalFunctions.get_default(
                                     "distribution_type_list", "default_values"
                                 ),
                             ),
-                            dense=True,
                             disabled=("distributionTypeDisabled",),
                         )
                 with vuetify.VRow(classes="my-2"):

src/python/impactx/dashboard/Input/generalFunctions.py

@@ -30,11 +30,11 @@ def documentation(section_name):
         :param section_name (str): The name of the documentation section to open.
         """
         url_dict = {
-            "LatticeElements": "https://impactx.readthedocs.io/en/latest/usage/python.html#lattice-elements",
-            "BeamDistributions": "https://impactx.readthedocs.io/en/latest/usage/python.html#initial-beam-distributions",
-            "pythonParameters": "https://impactx.readthedocs.io/en/latest/usage/python.html#general",
-            "space_charge_documentation": "https://impactx.readthedocs.io/en/latest/usage/parameters.html#space-charge",
-            "CSR": "https://impactx.readthedocs.io/en/latest/usage/parameters.html#coherent-synchrotron-radiation-csr",
+            "input_parameters": "https://impactx.readthedocs.io/en/latest/usage/python.html#general",
+            "lattice_configuration": "https://impactx.readthedocs.io/en/latest/usage/python.html#lattice-elements",
+            "distribution_parameters": "https://impactx.readthedocs.io/en/latest/usage/python.html#initial-beam-distributions",
+            "space_charge": "https://impactx.readthedocs.io/en/latest/usage/parameters.html#space-charge",
+            "csr": "https://impactx.readthedocs.io/en/latest/usage/parameters.html#coherent-synchrotron-radiation-csr",
         }
 
         url = url_dict.get(section_name)
@@ -154,16 +154,18 @@ def update_simulation_validation_status():
                     )
 
         # Check for errors in input card
-        if state.npart_validation:
-            error_details.append(f"Number of Particles: {state.npart_validation}")
-        if state.kin_energy_validation:
-            error_details.append(f"Kinetic Energy: {state.kin_energy_validation}")
-        if state.bunch_charge_C_validation:
-            error_details.append(f"Bunch Charge: {state.bunch_charge_C_validation}")
-        if state.charge_qe_validation:
-            error_details.append(f"Ref. Particle Charge: {state.charge_qe_validation}")
-        if state.mass_MeV_validation:
-            error_details.append(f"Ref. Particle Mass: {state.mass_MeV}")
+        if state.npart_error_message:
+            error_details.append(f"Number of Particles: {state.npart_error_message}")
+        if state.kin_energy_error_message:
+            error_details.append(f"Kinetic Energy: {state.kin_energy_error_message}")
+        if state.bunch_charge_C_error_message:
+            error_details.append(f"Bunch Charge: {state.bunch_charge_C_error_message}")
+        if state.charge_qe_error_message:
+            error_details.append(
+                f"Ref. Particle Charge: {state.charge_qe_error_message}"
+            )
+        if state.mass_MeV_error_message:
+            error_details.append(f"Ref. Particle Mass: {state.mass_MeV_error_message}")
 
         if state.selectedLatticeList == []:
             error_details.append("LatticeListIsEmpty")

src/python/impactx/dashboard/Input/inputParameters/inputMain.py

@@ -8,6 +8,7 @@
 
 from trame.widgets import vuetify
 
+from ...Input.trameFunctions import TrameFunctions
 from ...trame_setup import setup_server
 from ..generalFunctions import generalFunctions
 from .inputFunctions import InputFunctions
@@ -83,26 +84,19 @@ def __init__(self):
         state.charge_qe = generalFunctions.get_default("charge_qe", "default_values")
         state.mass_MeV = generalFunctions.get_default("mass_MeV", "default_values")
 
-        state.npart_validation = []
-        state.kin_energy_validation = []
-        state.bunch_charge_C_validation = []
-        state.mass_MeV_validation = []
-        state.charge_qe_validation = []
+        state.npart_error_message = []
+        state.kin_energy_error_message = []
+        state.bunch_charge_C_error_message = []
+        state.mass_MeV_error_message = []
+        state.charge_qe_error_message = []
 
     def card(self):
         """
         Creates UI content for beam properties.
         """
 
         with vuetify.VCard(style="width: 340px; height: 350px"):
-            with vuetify.VCardTitle("Input Parameters"):
-                vuetify.VSpacer()
-                vuetify.VIcon(
-                    "mdi-information",
-                    style="color: #00313C;",
-                    click=lambda: generalFunctions.documentation("pythonParameters"),
-                )
-            vuetify.VDivider()
+            TrameFunctions.input_section_header("Input Parameters")
             with vuetify.VCardText():
                 with vuetify.VRow(classes="py-2"):
                     with vuetify.VCol(cols=6, classes="py-0"):
@@ -119,95 +113,57 @@ def card(self):
                         )
                 with vuetify.VRow(classes="my-2"):
                     with vuetify.VCol(cols=6, classes="py-0"):
-                        vuetify.VTextField(
+                        TrameFunctions.text_field(
                             label="Ref. Particle Charge",
-                            v_model=("charge_qe",),
-                            suffix=generalFunctions.get_default("charge_qe", "units"),
-                            type="number",
-                            step=generalFunctions.get_default("charge_qe", "steps"),
-                            __properties=["step"],
-                            dense=True,
-                            error_messages=("charge_qe_validation",),
+                            v_model_name="charge_qe",
                             change=(
                                 ctrl.on_input_change,
-                                "[$event, 'int','charge_qe','charge_qe_validation', ['non_zero']]",
+                                "[$event, 'int','charge_qe','charge_qe_error_message', ['non_zero']]",
                             ),
                         )
                     with vuetify.VCol(cols=6, classes="py-0"):
-                        vuetify.VTextField(
+                        TrameFunctions.text_field(
                             label="Ref. Particle Mass",
-                            v_model=("mass_MeV",),
-                            suffix=generalFunctions.get_default("mass_MeV", "units"),
-                            type="number",
-                            step=generalFunctions.get_default("mass_MeV", "steps"),
-                            __properties=["step"],
-                            dense=True,
-                            error_messages=("mass_MeV_validation",),
+                            v_model_name="mass_MeV",
                             change=(
                                 ctrl.on_input_change,
-                                "[$event, 'float','mass_MeV','mass_MeV_validation', ['positive']]",
+                                "[$event, 'float','mass_MeV','mass_MeV_error_message', ['positive']]",
                             ),
                         )
                 with vuetify.VRow(classes="my-0"):
                     with vuetify.VCol(cols=12, classes="py-0"):
-                        vuetify.VTextField(
-                            v_model=("npart",),
+                        TrameFunctions.text_field(
                             label="Number of Particles",
-                            error_messages=("npart_validation",),
+                            v_model_name="npart",
                             change=(
                                 ctrl.on_input_change,
-                                "[$event, 'int','npart','npart_validation']",
+                                "[$event, 'int','npart','npart_error_message']",
                             ),
-                            type="number",
-                            step=generalFunctions.get_default("npart", "steps"),
-                            __properties=["step"],
-                            dense=True,
                         )
                 with vuetify.VRow(classes="my-2"):
                     with vuetify.VCol(cols=8, classes="py-0"):
-                        vuetify.VTextField(
-                            v_model=("kin_energy",),
+                        TrameFunctions.text_field(
                             label="Kinetic Energy",
-                            error_messages=("kin_energy_validation",),
+                            v_model_name="kin_energy",
                             change=(
                                 ctrl.on_input_change,
-                                "[$event, 'float','kin_energy','kin_energy_validation']",
+                                "[$event, 'float','kin_energy','kin_energy_error_message']",
                             ),
-                            type="number",
-                            step=generalFunctions.get_default("kin_energy", "steps"),
-                            __properties=["step"],
-                            dense=True,
                             classes="mr-2",
                         )
                     with vuetify.VCol(cols=4, classes="py-0"):
-                        vuetify.VSelect(
-                            v_model=("kin_energy_unit",),
+                        TrameFunctions.select(
                             label="Unit",
-                            items=(
-                                generalFunctions.get_default(
-                                    "kin_energy_unit_list", "default_values"
-                                ),
-                            ),
+                            v_model_name="kin_energy_unit",
                             change=(ctrl.kin_energy_unit_change, "[$event]"),
-                            dense=True,
                         )
                 with vuetify.VRow(classes="my-2"):
                     with vuetify.VCol(cols=12, classes="py-0"):
-                        vuetify.VTextField(
+                        TrameFunctions.text_field(
                             label="Bunch Charge",
-                            v_model=("bunch_charge_C",),
-                            error_messages=("bunch_charge_C_validation",),
+                            v_model_name="bunch_charge_C",
                             change=(
                                 ctrl.on_input_change,
-                                "[$event, 'float','bunch_charge_C','bunch_charge_C_validation']",
-                            ),
-                            type="number",
-                            step=generalFunctions.get_default(
-                                "bunch_charge_C", "steps"
-                            ),
-                            __properties=["step"],
-                            dense=True,
-                            suffix=generalFunctions.get_default(
-                                "bunch_charge_C", "units"
+                                "[$event, 'float','bunch_charge_C','bunch_charge_C_error_message']",
                             ),
                         )