From c1c9da2f8ac0901bbc8c9319f88b8f4e206feced Mon Sep 17 00:00:00 2001
From: Mika <kontakt@donau2space.de>
Date: Sun, 15 Mar 2026 12:31:25 +0000
Subject: [PATCH] Add readme_md

---
 readme_md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 readme_md

diff --git a/readme_md b/readme_md
new file mode 100644
index 0000000..b83974e
--- /dev/null
+++ b/readme_md
@@ -0,0 +1,85 @@
+# Resonanzband Test
+
+## Überblick
+Experiment **resonanzband_test** untersucht den Einfluss eines isolierten Toggles auf die Performance-Metriken des Resonanzbands in einem Cluster-Setup.
+
+[Link zum Artikel](https://donau2space.de/tag-178-run-24-ein-toggle-verstimmt-sich-das-resonanzband-oder-bleibt-der-max-stur/)
+
+Git Repository: [https://git.donau2space.de/Mika/resonanzband_test](https://git.donau2space.de/Mika/resonanzband_test)
+
+### 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
+Das Repository enthält Skripte, Datensätze und begleitende Dokumentation zum Experiment **resonanzband_test**.
+
+### Artefakte
+
+#### 1. Python-Skript
+- **Art:** python_script  
+- **Ziel:** Linux Userspace  
+- **Sprache:** Python  
+- **Beschreibung:** Automatische Analyse und Visualisierung der Performance-Metriken.  
+- **API-Funktionen:**  
+  - `analyze_metrics(data)` → gibt `analysis_results` zurück, führt eine Auswertung der übergebenen Messdaten durch.  
+- **Datenstrukturen:**  
+  - `performance_data` (JSON) mit Feldern: `max_only_alerts`, `outlier_frequency`, `expires_at_dist_hours`, `retry_total_overhead`.
+
+#### 2. CSV-Datensatz
+- **Art:** csv_dataset  
+- **Ziel:** gemischt  
+- **Sprache:** CSV  
+- **Beschreibung:** Enthält Metriken der Runs #22, #23 und #24 zur Nachanalyse.  
+- **Datenstruktur:**  
+  - `run_data` (Tabelle) mit Spalten: `run_id`, `max_only_alert_count`, `max_ms`, `outlier_frequency`, `expires_at_dist`, `retry_overhead`.
+
+#### 3. Dokumentation
+- **Art:** doc_only  
+- **Ziel:** gemischt  
+- **Beschreibung:** Dokumentation der Methodik, Entscheidungstabellen und Ergebnisinterpretationen.
+
+## Installation & Nutzung
+Voraussetzungen:  
+- Python 3.9 oder höher  
+- Empfohlen: virtuelles Environment
+
+### Installation
+1. Repository klonen:
+   ```bash
+   git clone https://git.donau2space.de/Mika/resonanzband_test.git
+   cd resonanzband_test
+   ```
+2. Abhängigkeiten installieren:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+### Nutzung
+Das Skript übergibt Datensätze im CSV-Format an die Analyselogik.
+
+Beispiel:
+```bash
+python analyze.py data/run_metrics.csv
+```
+
+## Typische Use-Cases
+- Vergleich der Resonanzband-Performance zwischen verschiedenen Cluster-Runs.  
+- Identifikation von Ausreißern und Performance-Degradation durch Toggles.  
+- Visualisierung und Dokumentation von Analyseergebnissen.  
+- Basis für weiterführende Optimierungsstudien.
+
+## Struktur & Erweiterbarkeit
+Das Projekt ist modular aufgebaut:
+- **/scripts**: enthält Analyseskripte  
+- **/data**: Datensätze der einzelnen Runs  
+- **/docs**: begleitende Dokumentation  
+
+Erweiterungen können durch Hinzufügen neuer Analysefunktionen oder weitere Datensatzformate erfolgen. Die API `analyze_metrics` kann zur Integration in externe Überwachungs- oder Benchmark-Tools verwendet werden.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+Alle Inhalte wurden automatisch generiert. Nutzung auf eigene Gefahr.
\ No newline at end of file