algomancy-content 0.3.12__py3-none-any.whl

algomancy_content/pages/standardhomepage.py

@@ -0,0 +1,275 @@
+from dash import html, get_app
+import dash
+import dash_bootstrap_components as dbc
+
+from algomancy_scenario import ScenarioStatus, ScenarioManager
+
+
+class StandardHomePage:
+    @staticmethod
+    def create_content():
+        """
+        Creates the content for the home page, including logo, status indicators,
+        and a summary of scenario processing status.
+
+        Implements the HomePage Protocol
+
+        Returns:
+            html.Div: A Dash HTML component representing the home page content
+        """
+        # Get scenario information
+        session_manager = get_app().server.session_manager
+        scenario_manager: ScenarioManager = session_manager.get_scenario_manager(
+            session_manager.start_session_name
+        )
+        all_scenarios = scenario_manager.list_scenarios()
+
+        # Count scenarios in each status
+        processing_count = sum(
+            1 for s in all_scenarios if s.status == ScenarioStatus.PROCESSING
+        )
+        queued_count = sum(
+            1 for s in all_scenarios if s.status == ScenarioStatus.QUEUED
+        )
+        completed_count = sum(
+            1 for s in all_scenarios if s.status == ScenarioStatus.COMPLETE
+        )
+        failed_count = sum(
+            1 for s in all_scenarios if s.status == ScenarioStatus.FAILED
+        )
+        created_count = sum(
+            1 for s in all_scenarios if s.status == ScenarioStatus.CREATED
+        )
+
+        # Define status indicators
+        status_indicators = [
+            StandardHomePage._create_status_card(
+                "Processing",
+                processing_count,
+                "primary",
+                "Scenarios currently being processed",
+            ),
+            StandardHomePage._create_status_card(
+                "Queued", queued_count, "info", "Scenarios waiting to be processed"
+            ),
+            StandardHomePage._create_status_card(
+                "Completed",
+                completed_count,
+                "success",
+                "Successfully completed scenarios",
+            ),
+            StandardHomePage._create_status_card(
+                "Failed", failed_count, "danger", "Scenarios that encountered errors"
+            ),
+            StandardHomePage._create_status_card(
+                "Created", created_count, "secondary", "Newly created scenarios"
+            ),
+        ]
+        logo_url = dash.get_asset_url("cqm-logo.png")
+
+        return html.Div(
+            [
+                # Header with logo
+                dbc.Row(
+                    [
+                        dbc.Col(width=4),
+                        dbc.Col(
+                            html.Div(
+                                [
+                                    html.H1(
+                                        "WARP Dashboard",
+                                        className="display-4",
+                                        style={"color": "var(--text-color)"},
+                                    ),
+                                    html.P(
+                                        "Workflow Analysis and Reporting Platform",
+                                        className="lead",
+                                        style={
+                                            "color": "var(--text-color)",
+                                            "opacity": 0.8,
+                                        },
+                                    ),
+                                ]
+                            ),
+                            width={"size": 6},
+                            className="d-flex align-items-center",
+                        ),
+                        dbc.Col(
+                            html.Img(src=logo_url, height="80px", className="mb-4"),
+                            width={"size": 2},
+                            className="d-flex align-items-center",
+                        ),
+                    ],
+                    className="mb-4",
+                ),
+                # System Status Section
+                dbc.Card(
+                    [
+                        dbc.CardHeader(
+                            html.H3("System Status", className="mb-0"),
+                            style={
+                                "backgroundColor": "transparent",
+                                "color": "var(--text-color)",
+                            },
+                        ),
+                        dbc.CardBody(
+                            [
+                                dbc.Row(
+                                    [
+                                        dbc.Col(
+                                            html.Div(
+                                                [
+                                                    html.H5(
+                                                        "Scenario Status Overview",
+                                                        className="mb-3",
+                                                        style={
+                                                            "color": "var(--text-color)"
+                                                        },
+                                                    ),
+                                                    dbc.Row(status_indicators),
+                                                ]
+                                            ),
+                                            width=12,
+                                        )
+                                    ]
+                                )
+                            ]
+                        ),
+                    ],
+                    className="mb-4",
+                    style={
+                        "backgroundColor": "var(--card-surface)",
+                        "border": "none",
+                        "boxShadow": "0 2px 8px rgba(0,0,0,0.12)",
+                    },
+                ),
+                # Quick Links Section
+                dbc.Card(
+                    [
+                        dbc.CardHeader(
+                            html.H3("Quick Links", className="mb-0"),
+                            style={
+                                "backgroundColor": "transparent",
+                                "color": "var(--text-color)",
+                            },
+                        ),
+                        dbc.CardBody(
+                            dbc.Row(
+                                [
+                                    StandardHomePage._create_quick_link(
+                                        "Create Scenario",
+                                        "/scenarios/create",
+                                        "Create a new scenario",
+                                        "primary",
+                                    ),
+                                    StandardHomePage._create_quick_link(
+                                        "View Scenarios",
+                                        "/scenarios",
+                                        "View all scenarios",
+                                        "info",
+                                    ),
+                                    StandardHomePage._create_quick_link(
+                                        "Compare",
+                                        "/compare",
+                                        "Compare two scenarios",
+                                        "success",
+                                    ),
+                                    StandardHomePage._create_quick_link(
+                                        "Data Import",
+                                        "/data",
+                                        "Import or manage data",
+                                        "warning",
+                                    ),
+                                ]
+                            )
+                        ),
+                    ],
+                    style={
+                        "backgroundColor": "var(--card-surface)",
+                        "border": "none",
+                        "boxShadow": "0 2px 8px rgba(0,0,0,0.12)",
+                    },
+                ),
+            ],
+            className="p-4",
+            style={"color": "var(--text-color)"},
+        )
+
+    @staticmethod
+    def _create_status_card(title, count, color, tooltip):
+        """Create a card showing a status count with appropriate styling responsive to theme."""
+        return dbc.Col(
+            dbc.Card(
+                [
+                    dbc.CardBody(
+                        [
+                            html.H4(
+                                f"{count}",
+                                className="text-center",
+                                style={"color": "var(--text-selected)"},
+                            ),
+                            html.P(
+                                title,
+                                className="text-center mb-0",
+                                style={"color": "var(--text-selected)"},
+                            ),
+                        ]
+                    )
+                ],
+                className="mb-3 text-center",
+                id=f"status-card-{title.lower()}",
+                style={
+                    "cursor": "pointer",
+                    "background": f"var(--status-{title.lower()})",
+                    "border": "none",
+                    "boxShadow": "0 2px 8px rgba(0,0,0,0.12)",
+                },
+            ),
+            width={"size": 2, "offset": 0},
+            className="mx-auto",
+        )
+
+    @staticmethod
+    def _create_quick_link(title, href, description, color):
+        """Create a quick link card for navigation."""
+        return dbc.Col(
+            dbc.Card(
+                [
+                    dbc.CardBody(
+                        [
+                            html.H5(
+                                title,
+                                className="card-title",
+                                style={"color": "var(--text-color)"},
+                            ),
+                            html.P(
+                                description,
+                                className="card-text",
+                                style={"color": "var(--text-color)", "opacity": 0.9},
+                            ),
+                            dbc.Button(
+                                "Go",
+                                href=href,
+                                className="mt-2",
+                                style={
+                                    "backgroundColor": "var(--theme-secondary)",
+                                    "color": "var(--text-selected)",
+                                    "border": "none",
+                                },
+                            ),
+                        ]
+                    )
+                ],
+                className="h-100",
+                style={
+                    "backgroundColor": "rgba(0,0,0,0.0)",
+                    "border": "1px solid rgba(255,255,255,0.1)",
+                },
+            ),
+            width=3,
+            className="mb-4",
+        )
+
+    @staticmethod
+    def register_callbacks():
+        pass

algomancy_content/pages/standardoverviewpage.py

@@ -0,0 +1,135 @@
+from dash import html, dash_table, callback, Output, Input, get_app, State
+
+from dash import dcc
+
+from algomancy_gui.componentids import ACTIVE_SESSION
+from algomancy_scenario import ScenarioManager
+
+OVERVIEW_TABLE = "overview-table"
+OVERVIEW_UPDATE_INTERVAL = "overview-update-interval"
+
+
+class StandardOverviewPage:
+    @staticmethod
+    def create_content():
+        """
+        Creates the overview page layout with a table of completed scenarios and their KPIs.
+
+        This page displays a table where rows represent completed scenarios and columns represent KPIs.
+
+        Returns:
+            html.Div: A Dash HTML component representing the overview page
+        """
+        page = html.Div(
+            [
+                html.H2("Scenarios Overview"),
+                html.Hr(),
+                # Description
+                html.P(
+                    "This page shows an overview of all completed scenarios and their KPIs."
+                ),
+                # Table container
+                html.Div(
+                    [
+                        # The table will be populated by a callback
+                        dash_table.DataTable(
+                            id=OVERVIEW_TABLE,
+                            style_table={
+                                "overflowX": "auto",
+                            },
+                            style_cell={
+                                "textAlign": "center",
+                                "padding": "10px",
+                            },
+                            style_header={
+                                "backgroundColor": "rgb(230, 230, 230)",
+                                "fontWeight": "bold",
+                                "textAlign": "center",
+                            },
+                            style_data_conditional=[
+                                {
+                                    "if": {"row_index": "odd"},
+                                    "backgroundColor": "rgb(248, 248, 248)",
+                                }
+                            ],
+                        ),
+                    ],
+                    style={"marginTop": "20px"},
+                ),
+                # Interval for periodic updates
+                dcc.Interval(
+                    id=OVERVIEW_UPDATE_INTERVAL,
+                    interval=5000,  # in milliseconds
+                    n_intervals=0,
+                ),
+            ]
+        )
+
+        return page
+
+    @staticmethod
+    def register_callbacks():
+        @callback(
+            Output(OVERVIEW_TABLE, "data"),
+            Output(OVERVIEW_TABLE, "columns"),
+            Input(OVERVIEW_UPDATE_INTERVAL, "n_intervals"),
+            Input("url", "pathname"),
+            State(ACTIVE_SESSION, "data"),
+        )
+        def update_overview_table(n_intervals, pathname, session_id: str):
+            """
+            Updates the overview table with completed scenarios and their KPIs.
+
+            Args:
+                n_intervals (int): Number of intervals elapsed (from dcc.Interval)
+                pathname (str): Current URL pathname
+                session_id (str): ID of the active session
+
+            Returns:
+                tuple: (
+                    list: Table data (rows),
+                    list: Table columns
+                )
+            """
+            # Only update when on the overview page
+            if pathname != "/overview":
+                return [], []
+
+            # Get the scenario manager
+            scenario_manager: ScenarioManager = (
+                get_app().server.session_manager.get_scenario_manager(session_id)
+            )
+
+            # Get completed scenarios
+            completed_scenarios = [
+                s for s in scenario_manager.list_scenarios() if s.is_completed()
+            ]
+
+            if not completed_scenarios:
+                return [], [{"name": "No completed scenarios", "id": "no_data"}]
+
+            # Get the first scenario to determine KPI columns
+            first_scenario = completed_scenarios[0]
+
+            # Create columns for the table
+            columns = [{"name": "Scenario", "id": "scenario_tag"}]
+
+            # Add columns for each KPI
+            for kpi_id, kpi in first_scenario.kpis.items():
+                column_name = f"{kpi.name}"
+                columns.append({"name": column_name, "id": kpi_id})
+
+            # Create data for the table
+            data = []
+            for scenario in completed_scenarios:
+                row = {"scenario_tag": scenario.tag}
+
+                # Add KPI values
+                for kpi_id, kpi in scenario.kpis.items():
+                    row[kpi_id] = kpi.pretty() + (
+                        f" ({kpi.details()})" if kpi.details() else ""
+                    )
+
+                data.append(row)
+
+            return data, columns

algomancy_content-0.3.12.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.3
+Name: algomancy-content
+Version: 0.3.12
+Summary: Placeholder content for quick start to the Algomancy library
+Author: Pepijn Wissing
+Author-email: Pepijn Wissing <Wsg@cqm.nl>
+Requires-Dist: algomancy-data
+Requires-Dist: algomancy-scenario
+Requires-Dist: dash
+Requires-Dist: dash-bootstrap-components
+Requires-Dist: dash-daq
+Requires-Dist: pandas
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+### algomancy-content
+
+Reusable content blocks (pages and callbacks) for Algomancy dashboards built with Dash. This package provides ready‑made creators for home, data, and overview pages, plus placeholder content to get you started quickly.
+
+#### Features
+- Standard page content creators (home, data, overview)
+- Placeholder content for instant scaffolding
+- Pairs naturally with `algomancy-gui` styling and the core launcher under `src/algomancy`
+
+#### Installation
+```
+pip install -e packages/algomancy-content
+```
+
+Requires Python >= 3.14.
+
+#### Quick start
+
+```python
+from algomancy_content import ShowcaseHomePage
+
+# Plug into your AppConfiguration (see project root `example/main.py`)
+home_content = ShowcaseHomePage.create_default_elements_showcase
+home_callbacks = ShowcaseHomePage.register_callbacks
+```
+
+Use the prebuilt standard home page:
+
+```python
+from algomancy_content.pages.standardhomepage import StandardHomePage
+
+home_content = StandardHomePage.create_content
+home_callbacks = StandardHomePage.register_callbacks
+```
+
+#### Related docs and examples
+- Example application: `example/main.py`
+- Root documentation: `documentation/3_dash_contents.md`

algomancy_content-0.3.12.dist-info/RECORD

@@ -0,0 +1,20 @@
+algomancy_content/__init__.py,sha256=q11Zi4b_hG192WxcxHhp0SgaBJ1feBy_uJr1gJBp4C8,972
+algomancy_content/backend/__init__.py,sha256=_W5qeuGE6oCdkXQq48k3Mr2WMpkIrFPBfVj-CmNix2Q,446
+algomancy_content/backend/placeholderalgorithmtemplate.py,sha256=Hy9GvkNGagN-15l1nHaGGJLWaqZCgQqcpH4ELTmYucw,712
+algomancy_content/backend/placeholderetlfactory.py,sha256=o6IVo1MWvBVYEfDOobmYXKgJ5vaIMNQF_6omRsnm0YI,935
+algomancy_content/backend/placeholderinputconfig.py,sha256=DoAKDMnOXBYfVISfJ66lYcD5kE7FbQWLAzAkDMYmL2Q,816
+algomancy_content/backend/placeholderkpitemplate.py,sha256=H1W1aAh4t_6avzKY36vDbq_g6RGS1g1l8PAj1f0uBSw,538
+algomancy_content/librarymanager.py,sha256=MubNqkSFIH3ooA71ecBFkVUA8gkiWeUkeCnLHlMpxN4,2423
+algomancy_content/pages/__init__.py,sha256=rh07pnYNxrDWsZXgpZ5V0OwmtT3ngnYEKsMAh31d1bU,794
+algomancy_content/pages/page.py,sha256=Hao1aXTzgTQJw4knA2n2dVZy0nPTM8CF2l5WxvHZuuE,1427
+algomancy_content/pages/placeholdercomparepage.py,sha256=dbmXqLz7t1Cy1Jw5Y953E8wLW36aO6NyNJpwPPYg1Ic,1430
+algomancy_content/pages/placeholderdatapage.py,sha256=PdNpphFdQpYU9hh40TGo-NnFo-6bbQclscBLisKZD6g,433
+algomancy_content/pages/placeholderscenariopage.py,sha256=LFsD9pGoVLk_h_B7aKM9oI3ds8cc3yBeYBMUIWC5Jj0,603
+algomancy_content/pages/showcasehomepage.py,sha256=i2UkRWA_JXSgLmXieI2uHmAHxOE6jmN1Kmuf1db-MZc,15245
+algomancy_content/pages/standarddatapage.py,sha256=k50M4FRxmDldaC9C4xguFi_5-IOBAUueISRwEM4okXU,1606
+algomancy_content/pages/standardhomepage.py,sha256=FcH41BaMwxuJfwLYLo2kIedeXT8LvnaUYDTy5pCi6Ps,11147
+algomancy_content/pages/standardoverviewpage.py,sha256=qqpNpGA3qK0KvFJBtxJYq1vPu4cNNUt0Q51ZhNIkelE,4818
+algomancy_content/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+algomancy_content-0.3.12.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+algomancy_content-0.3.12.dist-info/METADATA,sha256=_kcpszhcemJD_YX46UoMc93sGpWm4JOu0Cf5aDSAvho,1604
+algomancy_content-0.3.12.dist-info/RECORD,,

algomancy_content-0.3.12.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.28
+Root-Is-Purelib: true
+Tag: py3-none-any