Add README.md

This commit is contained in:
Mika 2026-03-20 11:41:46 +00:00
parent 8fdcd65004
commit 5b433a3562

87
README.md Normal file
View file

@ -0,0 +1,87 @@
# Experiment: run_29_single_toggle_parallelitaet
## Überblick
Dieses Projekt untersucht die **Auswirkungen von Parallelität auf das Resonanzband** in Leistungstests durch gezielte Variation der Last. Ziel ist es, zu verstehen, ob parallele Strukturen die Breite und Position des Resonanzbands verändern.
**Link zum Artikel:** [Zum Analysebericht auf donau2space.de](https://donau2space.de/tag-183-run-29-single-toggle-parallelitaet-wird-das-resonanzband-breiter-wenn-ich-nur-die-last-drehe/)
**Git Repository:** [https://git.donau2space.de/Mika/run_29_single_toggle_parallelitaet](https://git.donau2space.de/Mika/run_29_single_toggle_parallelitaet)
### 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 besteht aus mehreren Komponenten, die das Experiment run_29_single_toggle_parallelitaet dokumentieren und auswerten:
1. **artifact.1 Python-Skript**
**Art:** python_script
**Ziel:** mixed
**Sprachen:** Python
**Zweck:** Analyse und Auswertung der Benchmark-Daten, insbesondere der Metriken *band_width* und *retry_tail_p99*.
**API-Funktion:**
- `analyse_metrics(data)`: Führt eine Metrikanalyse durch und gibt ein *analysis_result* zurück.
**Datenstruktur:**
- `MetricData (json)` mit Feldern: *band_width*, *retry_tail_p99*, *band_center*
2. **artifact.2 CSV-Datensatz**
**Art:** csv_dataset
**Ziel:** mixed
**Sprachen:** CSV
**Zweck:** Enthält die Testergebnisse aus Run #29, einschließlich relevanter Metriken zur Bewertung der Parallelität.
**Datenstruktur:**
- `TestResults (table)` mit Spalten: *run_id*, *band_width*, *retry_tail_p99*, *band_center*
3. **artifact.3 Dokumentation**
**Art:** doc_only
**Ziel:** mixed
**Sprachen:** keine
**Zweck:** Beschreibt die Abfolge der Testläufe und erläutert die kausalen Zusammenhänge zwischen Lastvariation und Parallelität.
## Installation & Nutzung
Voraussetzung ist eine lokale Python-Umgebung (>=3.8).
### Installation
1. Repository klonen:
```bash
git clone https://git.donau2space.de/Mika/run_29_single_toggle_parallelitaet
cd run_29_single_toggle_parallelitaet
```
2. Abhängigkeiten installieren:
```bash
pip install -r requirements.txt
```
### Nutzung
Das Python-Skript kann zur Auswertung der Datensätze verwendet werden:
```bash
python analyse_metrics.py --input data/run_29_results.csv
```
Ergebnisse werden als Analysebericht (JSON oder CSV) ausgegeben.
## Typische Use-Cases
- Analyse der Resonanzbandveränderung unter Lastvariation.
- Bewertung von Parallelitätsauswirkungen auf Antwortzeiten und Bandbreite.
- Ableitung von Optimierungsempfehlungen für Systemkonfigurationen.
## Struktur & mögliche Erweiterungen
Das Projekt ist modular aufgebaut:
- `scripts/`: Python-Analysetools und Hilfsfunktionen.
- `data/`: CSV- und Analysedaten.
- `docs/`: Versuchsdokumentation, Ablaufbeschreibungen und Ergebnisse.
**Mögliche Erweiterungen:**
- Erweiterung der Analysefunktionen um weitere Metriken.
- Grafische Auswertung der Resonanzbandverschiebung.
- Automatisiertes Benchmark-Vergleichsmodul zwischen mehreren Runs.
## Lizenz
Dieses Projekt steht unter der **MIT-Lizenz**.
Alle Inhalte wurden automatisiert erzeugt. Verwendung und Anpassung erfolgen auf eigenes Risiko.