Add README.md

README.md

@@ -0,0 +1,88 @@
+# Affinity Load Interaction Analysis
+
+## Überblick
+Analyse der Interaktion zwischen Affinität und Last anhand quantitativer Effekte auf Bandbreite und Retry-Rate. Dieses Experiment trägt den Schlüssel **affinity_load_interaction_analysis** und untersucht Zusammenhänge zwischen CPU-Affinität, Systemlast und Leistungsparametern.
+
+**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.
+
+**Link zum Artikel:** [https://donau2space.de/tag-185-diff-of-diffs-steht-affinitaetxlast-ist-messbar-und-31-bekommt-eine-harte-schwelle/](https://donau2space.de/tag-185-diff-of-diffs-steht-affinitaetxlast-ist-messbar-und-31-bekommt-eine-harte-schwelle/)
+
+**Git Repository:** [https://git.donau2space.de/Mika/affinity_load_interaction_analysis](https://git.donau2space.de/Mika/affinity_load_interaction_analysis)
+
+## Inhalt des Repositories
+
+### Artefakte
+
+#### 1. affinity_effect_calculator
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprachen:** Python  
+- **Zweck:** Berechnet den Effekt von Affinität auf die Bandbreite basierend auf den Ergebnissen mehrerer Runs.  
+
+**API-Funktionen:**
+- `calculate_affinity_effect(effect_4x, effect_2x)` – Berechnet den kombinierten Effekt der gemessenen Affinitätsdaten.  
+
+**Verwendete Datenstruktur:**
+- `EffectData` (JSON): Felder `effect_4x`, `effect_2x`, `calculated_effect`
+
+#### 2. effects_dataset
+- **Art:** json_dataset  
+- **Ziel:** mixed  
+- **Sprachen:** JSON  
+- **Zweck:** Speicherung historischer Effekte von Affinität und Last zur weiteren quantitativen Auswertung.  
+
+**Datenstruktur:**
+- `HistoricalEffects` (JSON): Felder `date`, `effect_4x`, `effect_2x`, `calculated_effect`
+
+#### 3. affinity_analysis_documentation
+- **Art:** doc_only  
+- **Ziel:** mixed  
+- **Zweck:** Enthält die begleitende Dokumentation der Analyse, Methodik und Ergebnisse.
+
+## Installation & Nutzung
+
+### Python-Skript ausführen
+Voraussetzung: Python 3.x installiert.
+
+Generische Schritte:
+1. Repository klonen:
+   ```bash
+   git clone https://git.donau2space.de/Mika/affinity_load_interaction_analysis.git
+   ```
+2. In das Projektverzeichnis wechseln:
+   ```bash
+   cd affinity_load_interaction_analysis
+   ```
+3. Python-Umgebung vorbereiten (optional):
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate
+   ```
+4. Skript ausführen:
+   ```bash
+   python3 affinity_effect_calculator.py
+   ```
+
+Das Skript lädt Datensätze aus `effects_dataset` und berechnet darauf aufbauend Affinitätsmetriken.
+
+## Typische Use-Cases
+- Vergleich der Lastverteilung zwischen CPU-Kernen mit unterschiedlicher Affinität.
+- Bewertung der Auswirkung von Affinitätsstrategien auf die Systembandbreite.
+- Erstellung von Trainingsdaten für Optimierungsmodelle im Scheduling.
+
+## Struktur & mögliche Erweiterungen
+- **/scripts/** – enthält Python-Logik zur Effektberechnung.
+- **/data/** – JSON-Datensätze (historische Messungen).
+- **/docs/** – methodische Beschreibung und Analyseberichte.
+
+Zukünftige Erweiterungen:
+- Erweiterte Plot-Funktionalität zur grafischen Darstellung der Affinitätswirkungen.
+- Integration zusätzlicher Hardware-Metriken.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+Alle Inhalte stammen aus einer automatischen Generierung und dienen ausschließlich Demonstrations- und Forschungszwecken.