Add README.md

README.md

@@ -0,0 +1,89 @@
+# run_stability_analysis
+
+## Überblick
+
+Dieses Experiment analysiert die Stabilität von Systemmetriken über mehrere Runs und testet eine deterministische Exit-Regel.
+
+**Link zum Artikel:** [https://donau2space.de/tag-160-run-4-mini-zeitreihe-startet-exit-regel-bekommt-zaehne/](https://donau2space.de/tag-160-run-4-mini-zeitreihe-startet-exit-regel-bekommt-zaehne/)
+
+**Git Repository:** [https://git.donau2space.de/Mika/run_stability_analysis](https://git.donau2space.de/Mika/run_stability_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
+
+### 1. setup_fingerprint_logging
+**Art:** python_script  
+**Ziel:** linux-demo  
+**Sprache:** Python  
+**Zweck:** Erzeugt einen Setup-Fingerprint aus bestimmten Systemparametern und loggt ihn.  
+**API-Funktionen:**  
+- `generate_setup_fingerprint(policy_hash, runner_image, kernel, python_version, gate_version)` → Gibt einen eindeutigen Fingerprint-String zurück.
+
+### 2. metrics_reporting
+**Art:** python_script  
+**Ziel:** linux-userspace  
+**Sprache:** Python  
+**Zweck:** Berichtet Metriken über Warnraten und unpinned Anteile nach jedem Run.  
+**API-Funktionen:**  
+- `report_metrics(run_number, warn_rate, unknown_rate, unpin_delta_t)` → Führt eine Metrik-Übertragung ohne Rückgabe durch.  
+
+**Datenstruktur:**  
+- `Metrics` (JSON): Felder `run_number`, `warn_rate`, `unknown_rate`, `unpin_delta_t`
+
+### 3. exit_rule_definition
+**Art:** doc_only  
+**Ziel:** mixed  
+**Zweck:** Dokumentation und Definition einer deterministischen Exit-Regel basierend auf den beobachteten Metriken.  
+
+## Installation & Nutzung
+
+Voraussetzung: Python 3.8 oder höher unter Linux.
+
+### Installation
+
+1. Repository klonen:  
+   `git clone https://git.donau2space.de/Mika/run_stability_analysis`
+2. Abhängigkeiten installieren:  
+   `pip install -r requirements.txt`
+3. Optional: Virtuelle Umgebung anlegen und aktivieren.
+
+### Nutzung
+
+- Ausführung einzelner Python-Skripte direkt über die Kommandozeile:
+  - `python setup_fingerprint_logging.py`
+  - `python metrics_reporting.py`
+
+Kein spezielles CLI-Tool enthalten; Nutzung erfolgt über direkte Python-Calls oder in Automatisierungs-Skripten.
+
+## Typische Use-Cases
+
+- Vergleich von System-Metriken über mehrere Experiment-Runs.
+- Prüfung der Stabilität von Warn- und Fehlerraten.
+- Auswertung von deterministischen Abbruchbedingungen (Exit-Regel) anhand gemessener Parameter.
+- Dokumentation und Automatisierung in experimentellen Testplänen.
+
+## Struktur & mögliche Erweiterungen
+
+Die Repositoriumsstruktur ist modular aufgebaut:
+
+- **scripts/**: Python-Komponenten zur Fingerprint- und Metrikerfassung.
+- **docs/**: Definition der Exit-Regel und ergänzende Dokumentation.
+
+Zukünftige Erweiterungen können umfassen:
+- Erweiterung der Metrikaufzeichnung um neue Systemparameter.
+- Integration in kontinuierliche Testframeworks.
+- Mechanismen zur Auto-Kalibrierung von Exit-Kriterien.
+
+## Lizenz
+
+MIT-Lizenz
+
+---
+
+*Alle Inhalte in diesem Repository, inklusive dieser README.md, wurden automatisiert von einer KI generiert. Nutzung und Anpassung erfolgen auf eigenes Risiko.*