demo_interface.py

# Copyright 2024 D-Wave
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""This file stores the Dash HTML layout for the app."""
from __future__ import annotations

from dash import dcc, html

from demo_configs import (
    COLOR_BY_CASE,
    BIN_HEIGHT,
    BIN_LENGTH,
    BIN_WIDTH,
    CASE_DIM,
    DESCRIPTION,
    MAIN_HEADER,
    NUM_BINS,
    NUM_CASES,
    SOLVER_TIME,
    THEME_COLOR_SECONDARY,
    THUMBNAIL,
)
from src.demo_enums import ProblemType, ScenarioType, SolverType
from utils import TABLE_HEADERS


def slider(label: str, id: str, config: dict) -> html.Div:
    """Slider element for value selection.

    Args:
        label: The title that goes above the slider.
        id: A unique selector for this element.
        config: A dictionary of slider configerations, see dcc.Slider Dash docs.
    """
    return html.Div(
        className="slider-wrapper",
        children=[
            html.Label(label),
            dcc.Slider(
                id=id,
                className="slider",
                **config,
                marks={
                    config["min"]: str(config["min"]),
                    config["max"]: str(config["max"]),
                },
                tooltip={
                    "placement": "bottom",
                    "always_visible": True,
                },
            ),
        ],
    )


def dropdown(label: str, id: str, options: list) -> html.Div:
    """Dropdown element for option selection.

    Args:
        label: The title that goes above the dropdown.
        id: A unique selector for this element.
        options: A list of dictionaries of labels and values.
    """
    return html.Div(
        className="dropdown-wrapper",
        children=[
            html.Label(label),
            dcc.Dropdown(
                id=id,
                options=options,
                value=options[0]["value"],
                clearable=False,
                searchable=False,
            ),
        ],
    )


def checklist(label: str, id: str, options: list, values: list, inline: bool = True) -> html.Div:
    """Checklist element for option selection.

    Args:
        label: The title that goes above the checklist.
        id: A unique selector for this element.
        options: A list of dictionaries of labels and values.
        values: A list of values that should be preselected in the checklist.
        inline: Whether the options of the checklist are displayed beside or below each other.
    """
    return html.Div(
        className="checklist-wrapper",
        children=[
            html.Label(label),
            dcc.Checklist(
                id=id,
                className=f"checklist{' checklist--inline' if inline else ''}",
                inline=inline,
                options=options,
                value=values,
            ),
        ],
    )


def radio(label: str, id: str, options: list, value: int, inline: bool = True) -> html.Div:
    """Radio element for option selection.

    Args:
        label: The title that goes above the radio.
        id: A unique selector for this element.
        options: A list of dictionaries of labels and values.
        value: The value of the radio that should be preselected.
        inline: Whether the options are displayed beside or below each other.
    """
    return html.Div(
        className="radio-wrapper",
        children=[
            html.Label(label),
            dcc.RadioItems(
                id=id,
                className=f"radio{' radio--inline' if inline else ''}",
                inline=inline,
                options=options,
                value=value,
            ),
        ],
    )


def range_slider(label: str, id: str, config: dict) -> html.Div:
    """Range slider element for value selection."""
    return html.Div(
        className="range-slider",
        children=[
            html.Label(label),
            dcc.RangeSlider(
                id=id,
                **config,
                marks={
                    config["min"]: str(config["min"]),
                    config["max"]: str(config["max"]),
                },
                tooltip={
                    "placement": "bottom",
                    "always_visible": True,
                },
            ),
        ],
    )


def generate_options(options_list: list) -> list[dict]:
    """Generates options for dropdowns, checklists, radios, etc."""
    return [{"label": label, "value": i} for i, label in enumerate(options_list)]


def generate_settings_form() -> html.Div:
    """This function generates settings for selecting the scenario, model, and solver.

    Returns:
        html.Div: A Div containing the settings for selecting the scenario, model, and solver.
    """
    problem_type_options = [
        {"label": problem_type.label, "value": problem_type.value} for problem_type in ProblemType
    ]

    solver_options = [
        {"label": solver_type.label, "value": solver_type.value} for solver_type in SolverType
    ]

    scenario_options = [
        {"label": scenario_type.label, "value": scenario_type.value} for scenario_type in ScenarioType
    ]

    return html.Div(
        className="settings",
        children=[
            dropdown(
                "Problem Type",
                "problem-type",
                sorted(problem_type_options, key=lambda op: op["value"]),
            ),
            html.Div(
                [
                    html.Label("Problem File"),
                    dcc.Upload(
                        id="input-file",
                        children=html.Div(
                            ["Drag and Drop or ", html.A("Select a File"), html.Div(id="filename")]
                        ),
                    ),
                ],
                id="uploaded-settings",
                className="display-none",
            ),
            html.Div(
                [
                    slider(
                        "Number of Bins",
                        "num-bins",
                        NUM_BINS,
                    ),
                    html.Label("Bin Dimensions"),
                    html.Div(
                        [
                            html.Div(
                                [
                                    html.Label("Length"),
                                    dcc.Input(
                                        id="bin-length",
                                        type="number",
                                        **BIN_LENGTH,
                                    ),
                                ]
                            ),
                            html.Div(
                                [
                                    html.Label("Width"),
                                    dcc.Input(
                                        id="bin-width",
                                        type="number",
                                        **BIN_WIDTH,
                                    ),
                                ]
                            ),
                            html.Div(
                                [
                                    html.Label("Height"),
                                    dcc.Input(
                                        id="bin-height",
                                        type="number",
                                        **BIN_HEIGHT,
                                    ),
                                ]
                            ),
                        ],
                        className="display-flex-settings",
                    ),
                    slider(
                        "Number of Cases",
                        "num-cases",
                        NUM_CASES,
                    ),
                    range_slider(
                        "Case Dimension Bounds",
                        "case-dim",
                        CASE_DIM,
                    ),
                ],
                id={"type": "generated-settings", "index": 0},
            ),
            html.Div(
                [
                    dropdown(
                        "Scenario",
                        "scenario-select",
                        sorted(scenario_options, key=lambda op: op["value"]),
                    ),
                ],
                className="display-none",
                id="scenario-settings",
            ),
            dropdown(
                "Solver",
                "solver-type-select",
                sorted(solver_options, key=lambda op: op["value"]),
            ),
            html.Label("Solver Time Limit (seconds)"),
            dcc.Input(
                id="solver-time-limit",
                type="number",
                **SOLVER_TIME,
            ),
            html.Div(
                id={
                    "type": "to-collapse-class",
                    "index": 3,
                },
                className="details-collapse-wrapper collapsed",
                children=[
                    html.Button(
                        id={
                            "type": "collapse-trigger",
                            "index": 3,
                        },
                        className="details-collapse advanced-settings",
                        children=[
                            html.Label("More settings"),
                            html.Div(className="collapse-arrow"),
                        ],
                    ),
                    html.Div(
                        className="details-to-collapse advanced-collapse",
                        children=[
                            html.Label("Write Solution to File"),
                            dcc.Input(id="save-solution", type="text", placeholder="File Name"),
                        ],
                    ),
                ],
            ),
        ],
    )


def generate_run_buttons() -> html.Div:
    """Run and cancel buttons to run the optimization."""
    return html.Div(
        id="button-group",
        children=[
            html.Button(id="run-button", children="Run Optimization", n_clicks=0, disabled=False),
            html.Button(
                id="cancel-button",
                children="Cancel Optimization",
                n_clicks=0,
                className="display-none",
            ),
        ],
    )


def generate_table(table_data: dict) -> list[html.Thead, html.Tbody]:
    """Generates the input table.

    Args:
        table_data: Dictionary of lists of input data.

    Returns:
        list: The table head and table body of the results table.
    """
    body = [
        [table_data[table_header][i] for table_header in TABLE_HEADERS]
        for i in range(len(table_data[TABLE_HEADERS[0]]))
    ]
    return [
        html.Thead([html.Tr([html.Th(header) for header in TABLE_HEADERS])]),
        html.Tbody(generate_table_rows(body)),
    ]


def generate_table_rows(table_data: list[list]) -> list[html.Tr]:
    """Generates table rows.

    Args:
        table_data: A list of lists to display in table rows.

    Returns:
        list[html.Tr]: List of rows.
    """

    return [html.Tr([html.Td(cell) for cell in row]) for row in table_data]


def problem_details(index: int) -> html.Div:
    """Generate the problem details section.

    Args:
        index: Unique element id to differentiate matching elements.
            Must be different from left column collapse button.

    Returns:
        html.Div: Div containing a collapsable table.
    """
    return html.Div(
        id={"type": "to-collapse-class", "index": index},
        className="details-collapse-wrapper collapsed",
        children=[
            # Problem details collapsible button and header
            html.Button(
                id={"type": "collapse-trigger", "index": index},
                className="details-collapse",
                children=[
                    html.H5("Model Details"),
                    html.Div(className="collapse-arrow"),
                ],
            ),
            html.Div(
                className="details-to-collapse",
                children=[
                    html.Table(
                        className="solution-stats-table",
                        children=[
                            # Problem details table header (optional)
                            html.Thead(
                                [
                                    html.Tr(
                                        [
                                            html.Th(
                                                colSpan=3,
                                                children=["Variables"],
                                            ),
                                            html.Th(
                                                colSpan=3,
                                                children=["Constraints"],
                                            ),
                                            html.Th(
                                                colSpan=3,
                                                children=["Sensitivity"],
                                            ),
                                        ]
                                    )
                                ]
                            ),
                            # A Dash callback function will generate content in Tbody
                            html.Tbody(id="problem-details"),
                        ],
                    ),
                ],
            ),
        ],
    )


def create_interface():
    """Set the application HTML."""
    checklist_options = generate_options(COLOR_BY_CASE)

    return html.Div(
        id="app-container",
        children=[
            # Below are any temporary storage items, e.g., for sharing data between callbacks.
            dcc.Store(id="problem-data-store"),
            dcc.Store(id="max-bins-store"),
            dcc.Store(id="bin-dimensions-store"),
            # Header brand banner
            html.Div(className="banner", children=[html.Img(src=THUMBNAIL)]),
            # Settings and results columns
            html.Div(
                className="columns-main",
                children=[
                    # Left column
                    html.Div(
                        id={"type": "to-collapse-class", "index": 0},
                        className="left-column",
                        children=[
                            html.Div(
                                className="left-column-layer-1",  # Fixed width Div to collapse
                                children=[
                                    html.Div(
                                        className="left-column-layer-2",  # Padding and content wrapper
                                        children=[
                                            html.H1(MAIN_HEADER),
                                            html.P(DESCRIPTION),
                                            generate_settings_form(),
                                            generate_run_buttons(),
                                        ],
                                    )
                                ],
                            ),
                            # Left column collapse button
                            html.Div(
                                html.Button(
                                    id={"type": "collapse-trigger", "index": 0},
                                    className="left-column-collapse",
                                    children=[html.Div(className="collapse-arrow")],
                                ),
                            ),
                        ],
                    ),
                    # Right column
                    html.Div(
                        className="right-column",
                        children=[
                            dcc.Tabs(
                                id="tabs",
                                value="input-tab",
                                mobile_breakpoint=0,
                                children=[
                                    dcc.Tab(
                                        label="Input",
                                        id="input-tab",
                                        value="input-tab",  # used for switching tabs programatically
                                        className="tab",
                                        children=[
                                            html.Div(
                                                html.Div(
                                                    className="input",
                                                    children=[
                                                        html.Div(
                                                            html.Table(
                                                                id="input",
                                                                # add children dynamically using 'generate_table'
                                                            )
                                                        ),
                                                        html.Div(
                                                            [
                                                                html.H6(
                                                                    [
                                                                        "Maximum bins: ",
                                                                        html.Span(id="max-bins"),
                                                                    ]
                                                                ),
                                                                html.H6(
                                                                    [
                                                                        "Bin dimensions: ",
                                                                        html.Span(id="bin-dims"),
                                                                        " (L*W*H)",
                                                                    ]
                                                                ),
                                                                html.Div(
                                                                    [
                                                                        html.Label(
                                                                            "Save Input Data to File"
                                                                        ),
                                                                        html.Div(
                                                                            [
                                                                                dcc.Input(
                                                                                    id="save-input-filename",
                                                                                    type="text",
                                                                                    placeholder="File Name",
                                                                                ),
                                                                                html.Button(
                                                                                    id="save-input-button",
                                                                                    children="Save",
                                                                                    n_clicks=0,
                                                                                ),
                                                                                html.P(
                                                                                    "Saved to input folder",
                                                                                    className="display-none",
                                                                                    id="saved",
                                                                                ),
                                                                            ]
                                                                        ),
                                                                    ],
                                                                    id={
                                                                        "type": "generated-settings",
                                                                        "index": 1,
                                                                    },
                                                                ),
                                                            ]
                                                        ),
                                                    ],
                                                ),
                                                className="input-wrapper",
                                            ),
                                        ],
                                    ),
                                    dcc.Tab(
                                        label="Results",
                                        id="results-tab",
                                        className="tab",
                                        disabled=True,
                                        children=[
                                            html.Div(
                                                className="tab-content-results",
                                                children=[
                                                    checklist(
                                                        "",
                                                        "checklist",
                                                        sorted(
                                                            checklist_options,
                                                            key=lambda op: op["value"],
                                                        ),
                                                        [],
                                                    ),
                                                    dcc.Loading(
                                                        parent_className="results",
                                                        type="circle",
                                                        color=THEME_COLOR_SECONDARY,
                                                        # A Dash callback (in app.py) will generate content in the Div below
                                                        children=html.Div(
                                                            dcc.Graph(
                                                                id="results",
                                                                responsive=True,
                                                                config={"displayModeBar": False},
                                                            ),
                                                            className="graph",
                                                        ),
                                                    ),
                                                    # Problem details dropdown
                                                    html.Div([html.Hr(), problem_details(1)]),
                                                ],
                                            )
                                        ],
                                    ),
                                ],
                            )
                        ],
                    ),
                ],
            ),
        ],
    )