move function to GeneralFunctions

Future pr needs to split up generalFunctions
proy30 · Feb 11, 2025 · 4729288 · 4729288
1 parent 02d7fd9
commit 4729288
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 24 deletions.
diff --git a/src/python/impactx/dashboard/Input/components.py b/src/python/impactx/dashboard/Input/components.py
@@ -1,6 +1,6 @@
 from typing import Optional
 
-from .. import setup_server, html, vuetify
+from .. import html, setup_server, vuetify
 from .generalFunctions import generalFunctions
 
 server, state, ctrl = setup_server()
@@ -40,32 +40,10 @@ def documentation_icon(section_name: str) -> vuetify.VIcon:
         :param section_name: The name for the input section.
         """
 
-        def open_documentation():
-            """
-            Retrieves the documentation link with the provided section_name
-            and opens the documentation sidebar on the dashoard.
-            """
-
-            DOCUMENTATION = {
-                "input_parameters": "https://impactx.readthedocs.io/en/latest/usage/python.html#impactx.ImpactX",
-                "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",
-            }
-
-
-            new_url = DOCUMENTATION.get(section_name)
-            if state.documentation_drawer_open and state.documentation_url == new_url:
-                state.documentation_drawer_open = False
-            else:
-                state.documentation_url = new_url
-                state.documentation_drawer_open = True
-
         return vuetify.VIcon(
             "mdi-information",
             style="color: #00313C;",
-            click=open_documentation,
+            click=lambda: generalFunctions.open_documentation(section_name),
         )
 
     @staticmethod

diff --git a/src/python/impactx/dashboard/Input/defaults.py b/src/python/impactx/dashboard/Input/defaults.py
@@ -113,3 +113,11 @@ class DashboardDefaults:
         "beta": "m",
         "emitt": "m",
     }
+
+    DOCUMENTATION = {
+        "input_parameters": "https://impactx.readthedocs.io/en/latest/usage/python.html#impactx.ImpactX",
+        "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",
+    }
diff --git a/src/python/impactx/dashboard/Input/generalFunctions.py b/src/python/impactx/dashboard/Input/generalFunctions.py
@@ -20,6 +20,22 @@
 
 
 class generalFunctions:
+    @staticmethod
+    def open_documentation(section_name):
+        """
+        Retrieves the documentation link with the provided section_name
+        and opens the documentation sidebar on the dashoard.
+
+        :param section_name: The name for the input section.
+        """
+
+        new_url = DashboardDefaults.DOCUMENTATION.get(section_name)
+        if state.documentation_drawer_open and state.documentation_url == new_url:
+            state.documentation_drawer_open = False
+        else:
+            state.documentation_url = new_url
+            state.documentation_drawer_open = True
+
     @staticmethod
     def get_default(parameter, type):
         parameter_type_dictionary = getattr(DashboardDefaults, f"{type.upper()}", None)