# lakshyasisodiya/time-table-optimizer architecture

> Architecture diagram of the GitHub repository lakshyasisodiya/time-table-optimizer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lakshyasisodiya/time-table-optimizer
- Repository: https://github.com/lakshyasisodiya/time-table-optimizer

## Overview

The repository presents a timetable-optimization learning project, but the sampled runtime implements only Step 1: a user runs a CSV validator, which reads the sample data, checks its schema and domain rules, and prints a pass message or errors. The README also documents baseline and genetic-algorithm optimization capabilities; their implementations were not sampled, so they are shown as documented capabilities rather than connected runtime stages. The graph does not infer links from the validator to either optimizer.

Main entry points: [`src/validate_data.py`](https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/src/validate_data.py) (Data validator), [`docs/baseline-pseudocode.md`](https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/docs/baseline-pseudocode.md) (Baseline method), [`docs`](https://github.com/lakshyasisodiya/time-table-optimizer/tree/main/docs) (Genetic algorithm), [`data/sample_input.csv`](https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/data/sample_input.csv) (Sample input)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_validation["Data validation"]
  node_validator["Data validator<br/>[validate_data.py]"]
  node_sample_data["Sample input<br/>[sample_input.csv]"]
  node_validation_status["Validation status<br/>[validate_data.py]"]
end

subgraph group_optimization["Timetable optimization"]
  node_timetable["Clash-free timetable"]
  node_baseline["Baseline method"]
  node_genetic_algorithm["Genetic algorithm"]
end

node_user(("Project user"))

node_user -->|"runs"| node_validator
node_validator -->|"reads"| node_sample_data
node_validator -->|"prints"| node_validation_status
node_baseline -.->|"produces"| node_timetable
node_genetic_algorithm -.->|"produces"| node_timetable

click node_validator "https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/src/validate_data.py"
click node_sample_data "https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/data/sample_input.csv"
click node_validation_status "https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/src/validate_data.py"
click node_baseline "https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/docs/baseline-pseudocode.md"
click node_genetic_algorithm "https://github.com/lakshyasisodiya/time-table-optimizer/tree/main/docs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_validator,node_sample_data,node_validation_status,node_user toneBlue
class node_timetable,node_baseline,node_genetic_algorithm toneAmber
```

## Components

### Data validation

- [Data validator](https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/src/validate_data.py): `src/validate_data.py`
- [Sample input](https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/data/sample_input.csv): `data/sample_input.csv`
- [Validation status](https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/src/validate_data.py): `src/validate_data.py`

### Timetable optimization

- **Clash-free timetable**
- [Baseline method](https://github.com/lakshyasisodiya/time-table-optimizer/blob/main/docs/baseline-pseudocode.md): `docs/baseline-pseudocode.md`
- [Genetic algorithm](https://github.com/lakshyasisodiya/time-table-optimizer/tree/main/docs): `docs`

### Other components

- **Project user**

## Connections

- Project user → Data validator: runs (evidence: `src/validate_data.py`)
- Data validator → Sample input: reads (evidence: `src/validate_data.py`)
- Data validator → Validation status: prints (evidence: `src/validate_data.py`)
- Baseline method → Clash-free timetable: produces (evidence: `README.md`)
- Genetic algorithm → Clash-free timetable: produces (evidence: `README.md`)
