siliconcompiler 0.34.1__py3-none-any.whl → 0.34.3__py3-none-any.whl

siliconcompiler/report/dashboard/web/layouts/vertical_flowgraph.py

@@ -1,3 +1,7 @@
+"""
+Defines a dashboard layout that organizes different views into a set of
+vertical tabs using Streamlit's native `st.tabs` component.
+"""
 import os
 import streamlit
 
@@ -9,12 +13,23 @@ from siliconcompiler.report.dashboard.web.layouts import _common
 
 
 def layout():
+    """
+    Constructs a layout using Streamlit's native tabs.
+
+    This function sets up the main page header and then creates a tabbed
+    interface for the primary content areas. The "Metrics" tab is a
+    comprehensive view containing the flowgraph, metrics table, and detailed
+    node information. Other views like the Manifest, File Viewer, and Graphs
+    are in separate, conditionally rendered tabs.
+    """
     chip = state.get_chip()
     metric_dataframe, node_to_step_index_map, metric_to_metric_unit_map = \
         utils.generate_metric_dataframe(chip)
 
+    # Render the main page header (title, job selector, settings)
     components.page_header()
 
+    # --- Dynamically create tabs based on available data ---
     tab_headings = ["Metrics", "Manifest", "File Viewer"]
     if os.path.isfile(f'{chip.getworkdir()}/{chip.design}.png'):
         tab_headings.append("Design Preview")
@@ -23,50 +38,43 @@ def layout():
     if has_graphs:
         tab_headings.append("Graphs")
 
-    tabs = {
-        name: tab for name, tab in zip(tab_headings, streamlit.tabs(tab_headings))
-    }
+    # Create a dictionary mapping tab names to the tab container objects
+    tabs = {name: tab for name, tab in zip(tab_headings, streamlit.tabs(tab_headings))}
 
+    # --- Populate the "Metrics" tab ---
     with tabs["Metrics"]:
-        # Add flowgraph
         if state.get_key(state.DISPLAY_FLOWGRAPH):
+            # Create a two-column layout for the flowgraph and main content
             default_flowgraph_width_in_percent = 0.4
             flowgraph_col_width_in_pixels = 520
-            flowgraph_col_width_in_percent = \
-                state.compute_component_size(
-                    default_flowgraph_width_in_percent,
-                    flowgraph_col_width_in_pixels)
+            flowgraph_col_width_in_percent = state.compute_component_size(
+                default_flowgraph_width_in_percent,
+                flowgraph_col_width_in_pixels)
 
-            flowgraph_col, metrics_container = \
-                streamlit.columns(
-                    [flowgraph_col_width_in_percent, 1 - flowgraph_col_width_in_percent],
-                    gap="large")
+            flowgraph_col, metrics_container = streamlit.columns(
+                [flowgraph_col_width_in_percent, 1 - flowgraph_col_width_in_percent],
+                gap="large")
 
             with flowgraph_col:
-                header_col, flowgraph_toggle_container = streamlit.columns(2, gap="large")
-                with header_col:
-                    streamlit.header('Flowgraph')
+                streamlit.header('Flowgraph')
                 components.flowgraph_viewer(chip)
         else:
-            flowgraph_toggle_container = streamlit.container()
             metrics_container = streamlit.container()
 
-        with flowgraph_toggle_container:
-            streamlit.markdown("")
-            streamlit.markdown("")
-
+        with metrics_container:
+            # Add a toggle to hide/show the flowgraph
             if state.set_key(state.DISPLAY_FLOWGRAPH, not streamlit.checkbox(
-                    'Hide flowgraph',
+                    'Hide flowgraph', not state.get_key(state.DISPLAY_FLOWGRAPH),
                     help='Click here to hide the flowgraph')):
                 state.set_key(state.APP_RERUN, "Flowgraph")
 
-        with metrics_container:
+            # Display the main metrics table
             components.metrics_viewer(metric_dataframe, metric_to_metric_unit_map)
 
-            header_col, settings_col = \
-                streamlit.columns(
-                    [0.7, 0.3],
-                    gap='small')
+            streamlit.divider()
+
+            # Display the node information section within the same tab
+            header_col, settings_col = streamlit.columns([0.7, 0.3], gap='small')
             with header_col:
                 streamlit.header('Node Information')
             with settings_col:
@@ -76,15 +84,18 @@ def layout():
                 step, index = node_to_step_index_map[state.get_selected_node()]
                 components.node_viewer(chip, step, index, metric_dataframe)
 
+    # --- Populate the "Manifest" tab ---
     with tabs["Manifest"]:
         components.manifest_viewer(chip)
 
+    # --- Populate the "File Viewer" tab ---
     with tabs["File Viewer"]:
         components.file_viewer(
             chip,
             state.get_key(state.SELECTED_FILE),
             page_key=state.SELECTED_FILE_PAGE)
 
+    # --- Populate conditional tabs ---
     if "Design Preview" in tabs:
         with tabs["Design Preview"]:
             components.file_viewer(chip, f'{chip.getworkdir()}/{chip.design}.png')
@@ -93,4 +104,6 @@ def layout():
         with tabs["Graphs"]:
             graph.viewer(node_to_step_index_map)
 
+    # Check if a rerun is needed to switch to a different tab (not applicable
+    # for st.tabs, but kept for consistency with other layouts).
     _common.check_rerun()

siliconcompiler/report/dashboard/web/layouts/vertical_flowgraph_node_tab.py

@@ -1,3 +1,7 @@
+"""
+Defines a dashboard layout that organizes different views into a set of tabs
+using the streamlit-antd-components library.
+"""
 import os
 import streamlit
 
@@ -11,81 +15,76 @@ import streamlit_antd_components as sac
 
 
 def layout():
+    """
+    Constructs a tab-based layout for the web dashboard.
+
+    This function sets up the main page header and creates a tab group for
+    navigating between different views:
+    - Metrics: Shows the flowgraph alongside a table of key metrics.
+    - Node Information: Provides a detailed view of a selected node's data and files.
+    - Manifest: A searchable viewer for the chip's manifest.
+    - File Viewer: Displays the content of a selected file.
+    - Design Preview: Shows a preview image of the design, if available.
+    - Graphs: Interactive charts for comparing metrics across runs.
+
+    It handles the logic for displaying the content of the currently selected tab.
+    """
     chip = state.get_chip()
     metric_dataframe, node_to_step_index_map, metric_to_metric_unit_map = \
         utils.generate_metric_dataframe(chip)
 
+    # Render the main page header (title, job selector, settings)
     components.page_header()
 
+    # --- Define the tab items ---
     tab_headings = [
-        sac.TabsItem(
-            "Metrics",
-            icon='stack'),
-        sac.TabsItem(
-            "Node Information",
-            icon='diagram-2'),
-        sac.TabsItem(
-            "Manifest",
-            icon=file_utils.get_file_icon('manifest.pkg.json')),
-        sac.TabsItem(
-            "File Viewer",
-            icon=file_utils.get_file_icon(state.get_key(state.SELECTED_FILE))),
-        sac.TabsItem(
-            "Design Preview",
-            icon=file_utils.get_file_icon('design.png'),
-            disabled=not os.path.isfile(f'{chip.getworkdir()}/{chip.design}.png')),
-        sac.TabsItem(
-            "Graphs",
-            icon='graph-up',
-            disabled=len(state.get_key(state.LOADED_CHIPS)) == 1)
+        sac.TabsItem("Metrics", icon='stack'),
+        sac.TabsItem("Node Information", icon='diagram-2'),
+        sac.TabsItem("Manifest", icon=file_utils.get_file_icon('manifest.pkg.json')),
+        sac.TabsItem("File Viewer",
+                     icon=file_utils.get_file_icon(state.get_key(state.SELECTED_FILE))),
+        sac.TabsItem("Design Preview", icon=file_utils.get_file_icon('design.png'),
+                     disabled=not os.path.isfile(f'{chip.getworkdir()}/{chip.design}.png')),
+        sac.TabsItem("Graphs", icon='graph-up',
+                     disabled=len(state.get_key(state.LOADED_CHIPS)) <= 1)
     ]
 
+    # Render the tabs and get the user's selection
     tab_selected = _common.sac_tabs(tab_headings)
 
+    # --- Render the content for the selected tab ---
     if tab_selected == "Metrics":
-        # Add flowgraph
         if state.get_key(state.DISPLAY_FLOWGRAPH):
+            # Create a two-column layout for the flowgraph and metrics table
             default_flowgraph_width_in_percent = 0.4
             flowgraph_col_width_in_pixels = 520
-            flowgraph_col_width_in_percent = \
-                state.compute_component_size(
-                    default_flowgraph_width_in_percent,
-                    flowgraph_col_width_in_pixels)
+            flowgraph_col_width_in_percent = state.compute_component_size(
+                default_flowgraph_width_in_percent, flowgraph_col_width_in_pixels)
 
-            flowgraph_col, metrics_container = \
-                streamlit.columns(
-                    [flowgraph_col_width_in_percent, 1 - flowgraph_col_width_in_percent],
-                    gap="large")
+            flowgraph_col, metrics_container = streamlit.columns(
+                [flowgraph_col_width_in_percent, 1 - flowgraph_col_width_in_percent],
+                gap="large")
 
             with flowgraph_col:
-                header_col, flowgraph_toggle_container = streamlit.columns(2, gap="large")
-                with header_col:
-                    streamlit.header('Flowgraph')
+                streamlit.header('Flowgraph')
                 components.flowgraph_viewer(chip)
         else:
-            flowgraph_toggle_container = streamlit.container()
             metrics_container = streamlit.container()
 
-        with flowgraph_toggle_container:
-            streamlit.markdown("")
-            streamlit.markdown("")
-
+        with metrics_container:
+            # Add a toggle to hide/show the flowgraph
             if state.set_key(state.DISPLAY_FLOWGRAPH, not streamlit.checkbox(
-                    'Hide flowgraph',
+                    'Hide flowgraph', not state.get_key(state.DISPLAY_FLOWGRAPH),
                     help='Click here to hide the flowgraph')):
                 state.set_key(state.APP_RERUN, "Flowgraph")
 
-        with metrics_container:
             components.metrics_viewer(
                 metric_dataframe,
                 metric_to_metric_unit_map,
                 height=1000)
 
-    if tab_selected == "Node Information":
-        header_col, settings_col = \
-            streamlit.columns(
-                [0.7, 0.3],
-                gap='small')
+    elif tab_selected == "Node Information":
+        header_col, settings_col = streamlit.columns([0.7, 0.3], gap='small')
         with header_col:
             streamlit.header('Node Information')
         with settings_col:
@@ -95,23 +94,24 @@ def layout():
             step, index = node_to_step_index_map[state.get_selected_node()]
             current_file = state.get_key(state.SELECTED_FILE)
             components.node_viewer(chip, step, index, metric_dataframe, height=1000)
-            if state.get_key(state.SELECTED_FILE) and \
-                    current_file != state.get_key(state.SELECTED_FILE):
+            # Check if a file was selected within the node viewer
+            if current_file != state.get_key(state.SELECTED_FILE):
                 state.set_key(state.APP_RERUN, "File")
 
-    if tab_selected == "Manifest":
+    elif tab_selected == "Manifest":
         components.manifest_viewer(chip)
 
-    if tab_selected == "File Viewer":
+    elif tab_selected == "File Viewer":
         components.file_viewer(
             chip,
             state.get_key(state.SELECTED_FILE),
             page_key=state.SELECTED_FILE_PAGE)
 
-    if tab_selected == "Design Preview":
+    elif tab_selected == "Design Preview":
         components.file_viewer(chip, f'{chip.getworkdir()}/{chip.design}.png')
 
-    if tab_selected == "Graphs":
+    elif tab_selected == "Graphs":
         graph.viewer(node_to_step_index_map)
 
+    # Check if a rerun is needed to switch to a different tab
     _common.check_rerun()

siliconcompiler/report/dashboard/web/layouts/vertical_flowgraph_sac_tabs.py

@@ -1,3 +1,7 @@
+"""
+Defines a dashboard layout where the detailed node information is integrated
+directly into the main 'Metrics' tab, below the primary metrics table.
+"""
 import os
 import streamlit
 
@@ -11,74 +15,72 @@ import streamlit_antd_components as sac
 
 
 def layout():
+    """
+    Constructs an integrated layout for the web dashboard.
+
+    This function sets up the main page header and a tab group. The primary
+    "Metrics" tab is designed as a comprehensive view, containing the flowgraph,
+    the main metrics table, and the detailed node information viewer all in one
+    place. Other views like the Manifest, File Viewer, and Graphs are in
+    separate tabs.
+    """
     chip = state.get_chip()
     metric_dataframe, node_to_step_index_map, metric_to_metric_unit_map = \
         utils.generate_metric_dataframe(chip)
 
+    # Render the main page header (title, job selector, settings)
     components.page_header()
 
+    # --- Define the tab items ---
+    # Note: "Node Information" is not a separate tab in this layout.
     tab_headings = [
-        sac.TabsItem(
-            "Metrics",
-            icon='stack'),
-        sac.TabsItem(
-            "Manifest",
-            icon=file_utils.get_file_icon('manifest.pkg.json')),
-        sac.TabsItem(
-            "File Viewer",
-            icon=file_utils.get_file_icon(state.get_key(state.SELECTED_FILE))),
-        sac.TabsItem(
-            "Design Preview",
-            icon=file_utils.get_file_icon('design.png'),
-            disabled=not os.path.isfile(f'{chip.getworkdir()}/{chip.design}.png')),
-        sac.TabsItem(
-            "Graphs",
-            icon='graph-up',
-            disabled=len(state.get_key(state.LOADED_CHIPS)) == 1)
+        sac.TabsItem("Metrics", icon='stack'),
+        sac.TabsItem("Manifest", icon=file_utils.get_file_icon('manifest.pkg.json')),
+        sac.TabsItem("File Viewer",
+                     icon=file_utils.get_file_icon(state.get_key(state.SELECTED_FILE))),
+        sac.TabsItem("Design Preview", icon=file_utils.get_file_icon('design.png'),
+                     disabled=not os.path.isfile(f'{chip.getworkdir()}/{chip.design}.png')),
+        sac.TabsItem("Graphs", icon='graph-up',
+                     disabled=len(state.get_key(state.LOADED_CHIPS)) <= 1)
     ]
 
+    # Render the tabs and get the user's selection
     tab_selected = _common.sac_tabs(tab_headings)
 
+    # --- Render the content for the selected tab ---
     if tab_selected == "Metrics":
-        # Add flowgraph
+        # This tab contains the flowgraph, metrics table, and node details.
         if state.get_key(state.DISPLAY_FLOWGRAPH):
+            # Create a two-column layout for the flowgraph and main content
             default_flowgraph_width_in_percent = 0.4
             flowgraph_col_width_in_pixels = 520
-            flowgraph_col_width_in_percent = \
-                state.compute_component_size(
-                    default_flowgraph_width_in_percent,
-                    flowgraph_col_width_in_pixels)
+            flowgraph_col_width_in_percent = state.compute_component_size(
+                default_flowgraph_width_in_percent, flowgraph_col_width_in_pixels)
 
-            flowgraph_col, metrics_container = \
-                streamlit.columns(
-                    [flowgraph_col_width_in_percent, 1 - flowgraph_col_width_in_percent],
-                    gap="large")
+            flowgraph_col, metrics_container = streamlit.columns(
+                [flowgraph_col_width_in_percent, 1 - flowgraph_col_width_in_percent],
+                gap="large")
 
             with flowgraph_col:
-                header_col, flowgraph_toggle_container = streamlit.columns(2, gap="large")
-                with header_col:
-                    streamlit.header('Flowgraph')
+                streamlit.header('Flowgraph')
                 components.flowgraph_viewer(chip)
         else:
-            flowgraph_toggle_container = streamlit.container()
             metrics_container = streamlit.container()
 
-        with flowgraph_toggle_container:
-            streamlit.markdown("")
-            streamlit.markdown("")
-
+        with metrics_container:
+            # Add a toggle to hide/show the flowgraph
             if state.set_key(state.DISPLAY_FLOWGRAPH, not streamlit.checkbox(
-                    'Hide flowgraph',
+                    'Hide flowgraph', not state.get_key(state.DISPLAY_FLOWGRAPH),
                     help='Click here to hide the flowgraph')):
                 state.set_key(state.APP_RERUN, "Flowgraph")
 
-        with metrics_container:
+            # Display the main metrics table
             components.metrics_viewer(metric_dataframe, metric_to_metric_unit_map)
 
-            header_col, settings_col = \
-                streamlit.columns(
-                    [0.7, 0.3],
-                    gap='small')
+            streamlit.divider()
+
+            # Display the node information section within the same tab
+            header_col, settings_col = streamlit.columns([0.7, 0.3], gap='small')
             with header_col:
                 streamlit.header('Node Information')
             with settings_col:
@@ -88,23 +90,24 @@ def layout():
                 step, index = node_to_step_index_map[state.get_selected_node()]
                 current_file = state.get_key(state.SELECTED_FILE)
                 components.node_viewer(chip, step, index, metric_dataframe)
-                if state.get_key(state.SELECTED_FILE) and \
-                        current_file != state.get_key(state.SELECTED_FILE):
+                # Check if a file was selected to trigger a tab switch
+                if current_file != state.get_key(state.SELECTED_FILE):
                     state.set_key(state.APP_RERUN, "File")
 
-    if tab_selected == "Manifest":
+    elif tab_selected == "Manifest":
         components.manifest_viewer(chip)
 
-    if tab_selected == "File Viewer":
+    elif tab_selected == "File Viewer":
         components.file_viewer(
             chip,
             state.get_key(state.SELECTED_FILE),
             page_key=state.SELECTED_FILE_PAGE)
 
-    if tab_selected == "Design Preview":
+    elif tab_selected == "Design Preview":
         components.file_viewer(chip, f'{chip.getworkdir()}/{chip.design}.png')
 
-    if tab_selected == "Graphs":
+    elif tab_selected == "Graphs":
         graph.viewer(node_to_step_index_map)
 
+    # Check if a rerun is needed to switch to a different tab
     _common.check_rerun()