Add README.md

README.md

@@ -0,0 +1,93 @@
+# run_31_analysis
+
+## Überblick
+Analyse der Auswirkungen von paralleler Verarbeitung auf Bandbreite und Reaktionszeit in Tests mit unterschiedlichen Sättigungsgraden.
+
+**Link zum Artikel:** [https://donau2space.de/tag-186-run-31-4x→8x-gefahren-kippts-in-saettigung-oder-wird-nur-der-tail-nervoes/](https://donau2space.de/tag-186-run-31-4x%E2%86%928x-gefahren-kippts-in-saettigung-oder-wird-nur-der-tail-nervoes/)
+
+**Git Repo:** [https://git.donau2space.de/Mika/run_31_analysis](https://git.donau2space.de/Mika/run_31_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 Projekt *run_31_analysis* besteht aus mehreren Komponenten zur Datenerfassung, Analyse und Visualisierung.
+
+### Artefakte
+
+#### 1. bandwidth_analysis
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprachen:** Python  
+- **Zweck:** Analyse der Bandbreitenänderungen und Reaktionszeiten basierend auf gesammelten Testdaten.  
+
+**API-Funktion:**  
+- `analyze_bandwidth(baseline_data, test_data) → analysis_result`  
+  Analysiert Unterschiede in Bandbreite und Reaktionszeit anhand von Vergleichsdaten.
+
+**Datenstruktur:**  
+- `analysis_result` (JSON) mit Feldern: `bandwidth_change`, `retry_tail_change`, `hotspot_segments`
+
+#### 2. data_visualization
+- **Art:** web_ui  
+- **Ziel:** web  
+- **Sprachen:** HTML, CSS, JavaScript  
+- **Zweck:** Visualisierung der Testergebnisse und Analyseergebnisse über eine Weboberfläche.  
+
+**API-Route:**  
+- `GET /results` – Lädt aktuelle Testergebnisse zur Anzeige.
+
+**Verwendete Module:**  
+- `chart.js` für grafische Auswertungen
+
+#### 3. csv_export
+- **Art:** csv_dataset  
+- **Ziel:** mixed  
+- **Sprache:** CSV  
+- **Zweck:** Bereitstellung von exportierten Testergebnissen zur Weiterverarbeitung oder Analyse.  
+
+**Datenstruktur:**  
+- `test_results` (CSV) mit Feldern: `run_id`, `bandwidth`, `retry_tail`, `result_type`
+
+## Voraussetzungen (Webserver/DB)
+Für die *data_visualization*-Komponente wird ein Webserver benötigt, der statische Inhalte (HTML, CSS, JS) bereitstellt. Keine Datenbank erforderlich.
+
+## Installation & Nutzung
+
+### Python-Analyse-Skript
+1. Python 3.10+ installieren.
+2. Repository klonen:  
+   `git clone https://git.donau2space.de/Mika/run_31_analysis`
+3. In das Projektverzeichnis wechseln:  
+   `cd run_31_analysis`
+4. Abhängigkeiten installieren (z. B. mittels `pip install -r requirements.txt`).
+
+**Ausführung:**  
+`python bandwidth_analysis.py --input baseline.csv --test test.csv --output result.json`
+
+### Web-Oberfläche starten
+1. In das Verzeichnis `data_visualization/` wechseln.  
+2. Lokalen Webserver starten, z. B. `python -m http.server 8080`.
+3. Browser öffnen: `http://localhost:8080`
+
+### CSV-Daten
+Die Datei `csv_export/test_results.csv` kann direkt eingelesen oder in Tabellenkalkulationsprogrammen geöffnet werden.
+
+## Typische Use-Cases
+- Vergleich von Bandbreiten vor und nach Parallelisierung.
+- Identifikation von Reaktionszeiten unter Last.
+- Visualisierung von Sättigungseffekten über Zeit.
+- Export der Testergebnisse für weiterführende Analysen.
+
+## Struktur & Erweiterbarkeit
+- `bandwidth_analysis.py`: Analysemodul, erweiterbar um neue Metriken oder Datenquellen.
+- `data_visualization/`: Web-Frontend, modular über JavaScript-Komponenten (chart.js).
+- `csv_export/`: Ausgabe und Speicherung der Ergebnisse in CSV-Form.
+
+Erweiterungen sind möglich durch Integration zusätzlicher Analysetypen, Webkomponenten oder alternative Speicherformate.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+Alle Inhalte wurden automatisch generiert. Nutzung, Anpassung und Weiterentwicklung erfolgen auf eigene Verantwortung ohne Gewähr.