Update Dashboard Info Verbiage (BLAST-ImpactX#691)

* Added sentence to dashboard documentation * Add dashboard in-progress info in dashboard toolbar
proy30 · Aug 29, 2024 · 7c012df · 7c012df
1 parent 788f76c
commit 7c012df
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 3 deletions.
diff --git a/docs/source/usage/dashboard.rst b/docs/source/usage/dashboard.rst
@@ -9,6 +9,7 @@ It provides a graphical interface to a subset of ImpactX functionality.
 .. note::
 
    ImpactX Dashboard is provided as a preview and continues to be developed.
+   Thus, it may not yet include all the features available in ImpactX.
    Let us know in GitHub `discussions <https://github.com/ECP-WarpX/impactx/discussions>`__ and `issues <https://github.com/ECP-WarpX/impactx/issues>`__ how it works for you and what kind of workflows you would like to run in it.
 
 

diff --git a/src/python/impactx/dashboard/Toolbar/toolbarMain.py b/src/python/impactx/dashboard/Toolbar/toolbarMain.py
@@ -12,6 +12,8 @@
 
 server, state, ctrl = setup_server()
 
+state.show_dashboard_alert = True
+
 # -----------------------------------------------------------------------------
 # Common toolbar elements
 # -----------------------------------------------------------------------------
@@ -44,23 +46,43 @@ def run_simulation_button():
             disabled=("disableRunSimulationButton", True),
         )
 
+    @staticmethod
+    def dashboard_info():
+        """
+        Creates an alert box with dashboard information.
+        """
 
-# -----------------------------------------------------------------------------
-# Content
-# -----------------------------------------------------------------------------
+        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",
+        )
 
 
 class Toolbars:
     """
     Builds section toolbars for various pages.
     """
 
+    @staticmethod
+    def input_toolbar():
+        """
+        Builds toolbar for the 'Input' page.
+        """
+
+        (ToolbarElements.dashboard_info(),)
+
     @staticmethod
     def run_toolbar():
         """
         Builds toolbar for the 'Run' page.
         """
 
+        (ToolbarElements.dashboard_info(),)
         (vuetify.VSpacer(),)
         (ToolbarElements.run_simulation_button(),)
 
@@ -70,5 +92,6 @@ def analyze_toolbar():
         Builds toolbar for the 'Analyze' page.
         """
 
+        (ToolbarElements.dashboard_info(),)
         vuetify.VSpacer()
         ToolbarElements.plot_options()
diff --git a/src/python/impactx/dashboard/__main__.py b/src/python/impactx/dashboard/__main__.py
@@ -66,6 +66,8 @@ def application():
         with layout.toolbar:
             with vuetify.Template(v_if="$route.path == '/Analyze'"):
                 Toolbars.analyze_toolbar()
+            with vuetify.Template(v_if="$route.path == '/Input'"):
+                Toolbars.input_toolbar()
             with vuetify.Template(v_if="$route.path == '/Run'"):
                 Toolbars.run_toolbar()