Add README.md

README.md

@@ -0,0 +1,92 @@
+# rerun_budget_analysis
+
+## Überblick
+Analyse der Auswirkungen von `rerun_budget=1` auf Offline-Replays unter verschiedenen Bedingungen. Der Fokus liegt auf Entscheidungsprozessen und der Rolle von Unknowns.
+
+Weitere Informationen: [Artikel auf donau2space.de](https://donau2space.de/tag-136-rerun_budget1-im-offline-replay-hilft-wirklich-oder-schiebt-nur-weiter/)
+
+Git-Repository: [https://git.donau2space.de/Mika/rerun_budget_analysis](https://git.donau2space.de/Mika/rerun_budget_analysis)
+
+### 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
+Dieses Repository enthält drei Python-Skripte, die gemeinsam der Analyse und Entscheidungsunterstützung bei Rerun-Strategien dienen.
+
+### Artefakte
+
+#### 1. rerun_analysis_tool
+- **Art:** Python-Skript
+- **Ziel:** Linux Userspace
+- **Sprache:** Python
+- **Zweck:** Analyse von Rerun-Entscheidungen basierend auf Replay-Daten.
+
+**API-Funktionen:**
+- `analyze_runs(runs_data: list, threshold: float, rerun_budget: int) → dict`  
+  Analysiert Durchläufe und bewertet, inwieweit die Rerun-Entscheidung zu Verbesserungen oder Verschlechterungen führt.
+
+**Datenstruktur:**
+- `RunResult`: enthält Felder `rerun_helps`, `rerun_shifts`, `rerun_hurts`
+
+#### 2. unknowns_analysis
+- **Art:** Python-Skript
+- **Ziel:** Linux Userspace
+- **Sprache:** Python
+- **Zweck:** Untersuchung des Einflusses von Unknowns auf die Warnrate und Systemstabilität.
+
+**API-Funktionen:**
+- `analyze_unknowns(unknowns_data: list, warn_data: list) → dict`  
+  Bestimmt die Zusammenhänge zwischen Unknowns und Warnverhalten.
+
+**Datenstruktur:**
+- `UnknownAnalysisResult`: enthält Felder `total_unknowns`, `warn_increases`, `warn_stable`
+
+#### 3. decision_table_generator
+- **Art:** Python-Skript
+- **Ziel:** Linux Userspace
+- **Sprache:** Python
+- **Zweck:** Erstellung einer Entscheidungstabelle für Rerun-Strategien basierend auf konfigurierbaren Parametern.
+
+**API-Funktionen:**
+- `generate_decision_table(config: dict) → list`  
+  Generiert eine tabellarische Übersicht möglicher Strategien in Abhängigkeit von Konfigurationsparametern.
+
+**Datenstruktur:**
+- `DecisionConfig`: enthält Felder `N_values`, `warn_threshold`, `rerun_options`, `unknown_handling`
+
+## Installation & Nutzung
+Für die Nutzung aller Skripte ist eine Python-Umgebung (Version ≥3.8) erforderlich.
+
+### Installation
+1. Repository klonen:  
+   `git clone https://git.donau2space.de/Mika/rerun_budget_analysis`
+2. Abhängigkeiten installieren (falls benötigt):  
+   `pip install -r requirements.txt`
+
+### Nutzung
+Die Skripte können einzeln oder kombiniert ausgeführt werden, z. B.:
+- `python rerun_analysis_tool.py input.json`
+- `python unknowns_analysis.py unknown_data.json warn_data.json`
+- `python decision_table_generator.py config.json`
+
+## Typische Use-Cases
+- Bewertung des Nutzens von `rerun_budget=1` im Offline-Replay
+- Vergleich alternativer Rerun-Strategien
+- Analyse von Unknowns und deren Einfluss auf Warnraten
+- Erstellen tabellarischer Strategiezusammenfassungen für Entscheidungsmeetings
+
+## Struktur & mögliche Erweiterungen
+- **rerun_analysis_tool.py** – Kernanalysemodul für Replay-Daten
+- **unknowns_analysis.py** – Unterstützungsmodul zur Untersuchung von Unknowns
+- **decision_table_generator.py** – Generiert kombinierte Entscheidungsgrundlagen
+
+Mögliche Erweiterungen:
+- Integration zusätzlicher KPIs in die Analysefunktionen
+- Anbindung einer Weboberfläche zur interaktiven Visualisierung
+- Automatisierte Berichterstellung auf Basis der Analyseergebnisse
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+---
+Alle Inhalte wurden automatisch durch KI erstellt. Verwendung auf eigenes Risiko.