Add README.md

README.md

@@ -0,0 +1,87 @@
+# Laufzeit-Analyseexperiment (run_timing_experiment)
+
+## Überblick
+
+Analyse der Timing-Daten aus mehreren Laufversuchen zur Verbesserung der Präzision von Systementscheidungen.
+
+**Link zum Artikel:** [https://donau2space.de/tag-159-run-3-im-leichten-regen-der-unpinned-delay-muss-jetzt-liefern/](https://donau2space.de/tag-159-run-3-im-leichten-regen-der-unpinned-delay-muss-jetzt-liefern/)
+
+**Git Repository:** [https://git.donau2space.de/Mika/run_timing_experiment](https://git.donau2space.de/Mika/run_timing_experiment)
+
+### Hinweis
+Alle Inhalte wurden per KI generiert.
+
+Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich auf eigenes Risiko. Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
+
+## Inhalt des Repositories
+
+### 1. data_analysis
+- **Art**: Python-Skript (python_script)
+- **Ziel**: mixed (Terminal und Datenverarbeitung)
+- **Sprachen**: Python
+- **Zweck**: Analyse von Laufdaten, Berechnung von Warnraten und statistischer Verteilungen.
+
+**API-Funktionen:**
+- `calculate_warn_rate(data)` – Berechnet die Warnrate aus gegebenen Laufdaten.
+- `delta_time_distribution(data)` – Erzeugt statistische Kenngrößen der Zeitdifferenzen.
+
+**Datenstruktur:**
+- `RunData` (JSON) mit den Feldern: `policy_hash`, `warn_rate`, `unknown_rate`, `delta_time`
+
+### 2. visualization_tool
+- **Art**: Web-UI (web_ui)
+- **Ziel**: web
+- **Sprachen**: HTML, CSS, JavaScript
+- **Zweck**: Visuelle Darstellung der Messergebnisse und Analysen.
+
+**Routen:**
+- `GET /api/data` – Liefert Laufdatenobjekte vom Typ `RunData`.
+
+### 3. results_documentation
+- **Art**: Dokumentation (doc_only)
+- **Ziel**: mixed
+- **Sprachen**: Markdown
+- **Zweck**: Enthält interpretierende Auswertungen und Ergebnisberichte der Laufanalysen.
+
+## Voraussetzungen (Webserver/DB)
+Für die Weboberfläche wird ein lokaler oder entfernter Webserver (z. B. Apache oder nginx) benötigt. Es ist keine Datenbankintegration erforderlich, da Daten über eine API-Schnittstelle bereitgestellt werden.
+
+## Installation & Nutzung
+
+### Python-Analysemodul
+1. Python 3.x installieren.
+2. Repository klonen:
+   ```bash
+   git clone https://git.donau2space.de/Mika/run_timing_experiment
+   cd run_timing_experiment
+   ```
+3. Abhängigkeiten installieren (falls vorhanden, z. B. pandas, matplotlib).
+4. Skript ausführen:
+   ```bash
+   python data_analysis.py --input data/run_series.json --output results/
+   ```
+
+### Starten der Webanwendung
+1. Inhalte aus dem Verzeichnis `visualization_tool/` über einen Webserver bereitstellen.
+2. Zugriff über Browser, z. B. http://localhost/run_timing_experiment.
+
+## Typische Use-Cases
+- Berechnung und Visualisierung von Warnraten und Zeitstatistiken.
+- Vergleich mehrerer Laufversuche hinsichtlich Systemreaktionszeiten.
+- Erstellung von Visualisierungen für technische Entscheidungsvorlagen.
+
+## Struktur & Erweiterbarkeit
+- `data_analysis/` – analytische Kernskripte mit klar definierter Datenstruktur.
+- `visualization_tool/` – Weboberfläche für interaktive Analysen.
+- `results_documentation/` – Dokumentierte Ergebnisse und Beobachtungen.
+
+Zukünftige Erweiterungen:
+- Integration einer API zur Echtzeitdatenverarbeitung.
+- Automatisierte Generierung von Vergleichsberichten.
+- Zusätzliche visuelle Komponenten in der Web-UI.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+---
+**Hinweis:** Alle Inhalte wurden automatisch durch eine KI erstellt. Die Nutzung erfolgt auf eigenes Risiko.