# taldrain/sopic architecture

> Architecture diagram of the GitHub repository taldrain/sopic, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/taldrain/sopic
- Repository: https://github.com/taldrain/sopic

## Overview

##### Project type and purpose
- This is a Python GUI library (“sopic”) for defining and running test-station workflows (stations composed of ordered steps) with visualization, settings, and logging.
- It also contains a separate Remix/React-based documentation website under the “website” folder.

##### File structure
- Top-level:
- sopic/  → core library
- examples/ → demonstration scripts
- tests/ → unit tests
- assets/ → images for README and docs
- website/ → standalone Remix application for docs
- Inside sopic/:
- gui/ → Qt-style widgets (MainWindow, logger, settings dialog, step viewer, status displays)
- station.py → Station base class (DAG orchestration, run management)
- step.py → Step base class (start(), OK/KO result methods)
- utils/ → supporting modules (dag traversal, logger, settings persistence)
- The README explains the Station-Step DAG pattern, configuration via settings, and GUI keybinds.

##### README for additional insights
- The core API consists of Station and Step classes, with a DAG mapping keys to (StepClass, child keys).
- Examples show how users subclass and wire everything together.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Code
    UserScript["User Script (Example)"]:::user
    click UserScript "https://github.com/taldrain/sopic/tree/master/examples/"

    %% Core Library
    subgraph "Core Library"   
        direction TB
        StationMgr["Station Manager"]:::core
        click StationMgr "https://github.com/taldrain/sopic/blob/master/sopic/station.py"
        StepIface["Step Interface"]:::core
        click StepIface "https://github.com/taldrain/sopic/blob/master/sopic/step.py"
        DAGEngine["DAG Engine"]:::core
        click DAGEngine "https://github.com/taldrain/sopic/blob/master/sopic/utils/dag.py"
        SettingsMgr["Settings Manager"]:::core
        click SettingsMgr "https://github.com/taldrain/sopic/blob/master/sopic/utils/settings.py"
        LoggerCore["Logger (core)"]:::core
        click LoggerCore "https://github.com/taldrain/sopic/blob/master/sopic/utils/logger.py"
    end

    %% GUI Layer
    subgraph "GUI Layer"
        direction TB
        MainWindow["Main Window"]:::gui
        click MainWindow "https://github.com/taldrain/sopic/blob/master/sopic/gui/main_window.py"
        StartScreen["Start Screen Widget"]:::gui
        click StartScreen "https://github.com/taldrain/sopic/blob/master/sopic/gui/start_screen_widget.py"
        StepsViewer["Steps Viewer Widget"]:::gui
        click StepsViewer "https://github.com/taldrain/sopic/blob/master/sopic/gui/steps_viewer_widget.py"
        StationInfo["Station Info Widget"]:::gui
        click StationInfo "https://github.com/taldrain/sopic/blob/master/sopic/gui/station_info_widget.py"
        StationStatus["Station Status Widget"]:::gui
        click StationStatus "https://github.com/taldrain/sopic/blob/master/sopic/gui/station_status_widget.py"
        SettingsDialog["Settings Dialog Widget"]:::gui
        click SettingsDialog "https://github.com/taldrain/sopic/blob/master/sopic/gui/settings_dialog_widget.py"
        SettingsWidgets["Settings Custom Widgets"]:::gui
        click SettingsWidgets "https://github.com/taldrain/sopic/blob/master/sopic/gui/settings_widgets.py"
        LoggerWidget["Logger Panel Widget"]:::gui
        click LoggerWidget "https://github.com/taldrain/sopic/blob/master/sopic/gui/logger_widget.py"
    end

    %% External Artifacts
    SettingsFile["Settings File (JSON)"]:::external
    LogFile["Log File"]:::external
    PNGOutput["DAG PNG Output"]:::external
    DocsWebsite["Documentation Website"]:::external
    click DocsWebsite "https://github.com/taldrain/sopic/tree/master/website/"

    %% Relationships
    UserScript -->|"defines DAG & instantiates"| StationMgr
    StationMgr -->|"uses"| DAGEngine
    StationMgr -->|"calls start() on"| StepIface
    StepIface -->|"returns OK/KO"| StationMgr
    StationMgr -->|"reads/writes"| SettingsMgr
    SettingsMgr -->|"emits updates to"| StationMgr
    StationMgr -->|"logs events to"| LoggerCore
    LoggerCore -->|"writes entries to"| LogFile
    StationMgr -->|"emits events"| MainWindow
    MainWindow --> StartScreen
    MainWindow --> StepsViewer
    MainWindow --> StationInfo
    MainWindow --> StationStatus
    MainWindow --> SettingsDialog
    SettingsDialog --> SettingsMgr
    MainWindow --> LoggerWidget
    StationMgr -->|"if DEBUG emits"| PNGOutput
    DocsWebsite

    %% Event-driven updates
    StationMgr -->|"event stream"| StepsViewer
    StationMgr -->|"event stream"| StationInfo
    StationMgr -->|"event stream"| StationStatus
    StationMgr -->|"event stream"| LoggerWidget

    %% Styles
    classDef core fill:#D0E6FF,stroke:#0066CC,color:#003366;
    classDef gui fill:#DFFFD6,stroke:#33AA00,color:#004400;
    classDef user fill:#FFE5CC,stroke:#FF6600,color:#663300;
    classDef external fill:#EEEEEE,stroke:#888888,color:#555555;
```
