# piergit7/distributedrealtimesystem architecture

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

- Interactive diagram: https://gitdiagram.com/piergit7/distributedrealtimesystem
- Repository: https://github.com/piergit7/distributedrealtimesystem

## Overview

##### Project type and purpose
- This is a Python-based scheduling simulator / analysis tool.
- It ingests task, budget, and architecture descriptions (CSV files), applies scheduling policies (e.g., BDR, DBF, SRP), simulates execution, and writes out results.

##### File structure
- Top level:
- src/ – simulator code and core libraries
- data/ – input test cases and output CSVs
- tests/ – unit tests for the simulator
- assignment/ – project brief and a standalone simulator copy (not part of main code base)
- docs/ – usage examples
- environment.yml, pyproject.toml, requirements*.txt – dependency and environment config
- src/ hierarchy:
- src/simulator.py – CLI entry point
- src/analysis.py – post-simulation analysis tools
- src/common/ – core domain models (Task, Job, Component), schedulers, CSV I/O, utilities

##### README
- Describes how to invoke the simulator from a command line, confirming that the CLI is the main user interface.

##### Components and interactions
a. Main components:
1) CLI Runner (simulator.py)
2) Input Reader (csvreader.py)
3) Data Models (Task, Job, Component in common/)
4) Scheduler Engine (scheduler.py and policy modules BDR.py, DBF.py, SRPModel.py)
5) Output Writer (csvoutput.py)
6) Analysis Module (analysis.py)
7) Test Harness (tests/test_simulator.py)
8) Data Stores (data/custom/*.csv for inputs, data/simulator_outputs/*.csv for outputs)

b. Relationships and data flow:
- User invokes CLI Runner with a path to a task-file →
- CLI Runner calls Input Reader to parse CSVs into Data Models →
- Models are passed into Scheduler Engine →
- Scheduler executes chosen policy, emits scheduling decisions (Jobs) →
- Output Writer serializes results back to CSV →
- Analysis Module may post-process outputs (optional) →
- Tests exercise the end-to-end flow via the Test Harness.

c. Architectural patterns / design principles:
- Modular separation: I/O, domain model, algorithms, CLI, analysis.
- Strategy pattern for scheduling policies (BDR, DBF, SRP) via interchangeable modules.
- Single Responsibility: each common/*.py handles a focused concern (e.g., csvreader, scheduler).

d. Key technologies and libraries:
- Python 3 runtime (environment.yml, pyproject.toml)
- Standard library modules: csv, argparse, unittest (in tests): no heavy external dependencies.

##### Don’t overthink—capture every logical module
- Common/ files under a “Domain & Algorithms” container.
- External input/output folders as data sources/sinks.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Data Inputs
    DataInput["Input CSVs: data/custom/"]:::io

    %% CLI Interface
    CLI["CLI Runner"]:::logic

    %% I/O Components
    subgraph "I/O Components"
        InputReader["Input Reader"]:::io
        OutputWriter["Output Writer"]:::io
    end

    %% Domain & Algorithms
    subgraph "Domain & Algorithms"
        subgraph "Data Models"
            Task["Task"]:::model
            Job["Job"]:::model
            Component["Component"]:::model
        end
        SchedulerCore["Scheduler Engine Core"]:::logic
        subgraph "Policy Modules"
            BDR["BDR Policy"]:::logic
            DBF["DBF Policy"]:::logic
            SRP["SRP Policy"]:::logic
        end
    end

    %% Outputs and Analysis
    DataOutput["Output CSVs: data/simulator_outputs/"]:::io
    Analysis["Analysis Module"]:::logic

    %% Test Harness
    TestHarness["Test Harness"]:::test

    %% Connections
    CLI -->|"invoke"| InputReader
    DataInput -->|"parse CSV"| InputReader
    InputReader -->|"populate models"| Task
    InputReader -->|"populate models"| Job
    InputReader -->|"populate models"| Component
    Task -->|"to scheduler"| SchedulerCore
    Job -->|"to scheduler"| SchedulerCore
    Component -->|"to scheduler"| SchedulerCore

    SchedulerCore -->|"schedule()"| OutputWriter
    OutputWriter -->|"write CSV"| DataOutput
    DataOutput -.->|"post-process"| Analysis

    SchedulerCore -.->|"uses policy"| BDR
    SchedulerCore -.->|"uses policy"| DBF
    SchedulerCore -.->|"uses policy"| SRP

    TestHarness -.->|"tests CLI"| CLI
    TestHarness -.->|"tests engine"| SchedulerCore

    %% Click Events
    click CLI "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/simulator.py"
    click InputReader "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/csvreader.py"
    click Task "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/task.py"
    click Job "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/job.py"
    click Component "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/component.py"
    click SchedulerCore "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/scheduler.py"
    click BDR "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/BDR.py"
    click DBF "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/DBF.py"
    click SRP "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/SRPModel.py"
    click OutputWriter "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/common/csvoutput.py"
    click Analysis "https://github.com/piergit7/distributedrealtimesystem/blob/main/src/analysis.py"
    click TestHarness "https://github.com/piergit7/distributedrealtimesystem/blob/main/tests/test_simulator.py"
    click DataInput "https://github.com/piergit7/distributedrealtimesystem/tree/main/data/custom/"
    click DataOutput "https://github.com/piergit7/distributedrealtimesystem/tree/main/data/simulator_outputs/"

    %% Styles
    classDef io fill:#ADD8E6,stroke:#000
    classDef logic fill:#90EE90,stroke:#000
    classDef model fill:#FFFACD,stroke:#000
    classDef test fill:#D3D3D3,stroke:#000
```
