Add README.md

README.md

@@ -0,0 +1,86 @@
+# Band Width Analysis
+
+## Überblick
+Analyse der Beziehung zwischen *band_width*, *aux*-Werten und Mixanteilen zur Untersuchung von Drift und Systemverhalten.
+
+**Link zum Artikel:** [https://donau2space.de/tag-196-wenn-das-band-zittert-mix-stratum-als-haupttreiber-oder-doch-drift/](https://donau2space.de/tag-196-wenn-das-band-zittert-mix-stratum-als-haupttreiber-oder-doch-drift/)
+
+**Git Repo:** [https://git.donau2space.de/Mika/band_width_analysis](https://git.donau2space.de/Mika/band_width_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
+Das Repository **band_width_analysis** enthält drei Hauptartefakte zur Auswertung von Messdaten und Dokumentation der Analyseergebnisse.
+
+### 1. artifact_1_band_width_analysis
+- **Art:** Python-Skript (`python_script`)
+- **Ziel:** Linux-Userspace
+- **Sprachen:** Python
+- **Zweck:** Analyse der *band_width*-Daten aus verschiedenen Runs zur Ermittlung statistischer Kennzahlen und Vergleiche.
+
+**API-Funktionen:**
+- **calculate_statistics(data)** → Berechnet statistische Werte (z. B. Mittelwerte, Varianzen) über die übergebenen Datensätze. Gibt ein Dictionary zurück.
+- **compare_runs(run1, run2)** → Vergleicht zwei Runs anhand ausgewählter Kennzahlen und liefert Differenzen bzw. Driftindikatoren als Dictionary.
+
+**Datenstrukturen:**
+- **RunData (JSON)** – Felder: `band_width`, `aux`, `near_expiry`, `retry_tail_p99`
+
+### 2. artifact_2_csv_data_export
+- **Art:** CSV-Datensatz (`csv_dataset`)
+- **Ziel:** gemischt (Export und Weiterverarbeitung)
+- **Sprachen:** CSV
+- **Zweck:** Enthält die Analyseergebnisse der Runs als strukturierte Tabellen zur weiteren Evaluation oder Visualisierung.
+
+**Datenstrukturen:**
+- **RunMetrics (Tabelle)** – Felder: `run_id`, `band_width`, `aux`, `near_expiry`, `retry_tail_p99`
+
+### 3. artifact_3_documentation
+- **Art:** Dokumentation (`doc_only`)
+- **Ziel:** gemischt (technische und analytische Beschreibung)
+- **Zweck:** Enthält Beschreibung der Analysemethoden, der Ergebnisse und der Interpretation der Daten.
+
+## Installation & Nutzung
+Das Python-Skript benötigt eine Standard-Python-Umgebung (Version ≥ 3.8) mit Zugriff auf die CSV-Daten.
+
+**Schritte:**
+1. Repository klonen:
+   `git clone https://git.donau2space.de/Mika/band_width_analysis`
+2. Verzeichnis wechseln:
+   `cd band_width_analysis`
+3. Abhängigkeiten installieren:
+   `pip install -r requirements.txt`
+4. Skript ausführen:
+   `python band_width_analysis.py --input data/runs.csv --output results/statistics.json`
+
+## Typische Use-Cases
+- Vergleich der *band_width*-Verteilung zwischen zwei Experimentreihen.
+- Ermittlung von Drift- oder Stabilitätskennzahlen über mehrere Runs.
+- Ableiten von Korrelationen zwischen *aux*‑Parametern und *band_width*-Verhalten.
+- Erstellung von Berichten auf Basis der exportierten CSV-Daten.
+
+## Struktur & mögliche Erweiterungen
+```
+band_width_analysis/
+ ├── band_width_analysis.py
+ ├── data/
+ │   └── runs.csv
+ ├── results/
+ │   └── statistics.json
+ ├── docs/
+ │   └── analysis_overview.md
+ ├── requirements.txt
+ └── README.md
+```
+
+Mögliche Erweiterungen:
+- Erweiterung der Analysefunktionen um Regressionsmodelle.
+- Automatische Visualisierung der Driftmetriken.
+- Integration von Datenbankanbindungen zur Speicherung großer Run-Datenmengen.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+Die Inhalte wurden automatisch generiert. Verwendung und Änderungen erfolgen auf eigene Gefahr.