Add README.md

README.md

@@ -0,0 +1,102 @@
+# Gate Prototyp v0
+
+## Überblick
+Dieses Repository mit dem Experiment-Key **gate_prototyp_v0** enthält die Entwicklung eines Gate-Prototypen zur stabilen Entscheidungsfindung basierend auf Rohdaten unter Verwendung von p95 als Primärsignal.
+
+**Artikel:** [https://donau2space.de/tag-129-1837-bedeckt-ueber-passau-und-mein-p95-wird-zum-ersten-echten-gate-v0/](https://donau2space.de/tag-129-1837-bedeckt-ueber-passau-und-mein-p95-wird-zum-ersten-echten-gate-v0/)  
+**Git Repository:** [https://git.donau2space.de/Mika/gate_prototyp_v0](https://git.donau2space.de/Mika/gate_prototyp_v0)
+
+### 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
+Dieses Repository umfasst mehrere Python-Skripte zur Analyse, Entscheidungsfindung und Erzeugung von Debug-Informationen für Gate-Strukturen.
+
+### Artefakt-Liste
+
+#### 1. run_summary
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprache:** Python  
+- **Zweck:** Erzeugung einer Run-Summary basierend auf Rohdaten.
+- **API-Funktion:**
+  - `generate_summary(raw_events) → summary_data` – Generiert eine strukturierte Zusammenfassung der Eingangsdaten.
+- **Datenstruktur:** `summary_data` (JSON) mit Feldern: `mischfenster_p95`, `retry_free_in_window_rate`.
+
+#### 2. gate_decision
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprache:** Python  
+- **Zweck:** Entscheidungsfindung auf Basis der v0-Regel unter Verwendung der zuvor erzeugten Summary.
+- **API-Funktion:**
+  - `make_decision(summary_data) → gate_decision` – Berechnet eine Entscheidung und liefert eine Erklärung.
+- **Datenstruktur:** `gate_decision` (JSON) mit Feldern: `decision`, `explanation`.
+
+#### 3. debug_artifact
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprache:** Python  
+- **Zweck:** Erstellung von Debug-Informationen für problematische oder extreme Mischfenster.
+- **API-Funktion:**
+  - `create_debug_artifact(raw_events) → debug_info` – Liefert Debug-Indikatoren zu auffälligen Datenbereichen.
+- **Datenstruktur:** `debug_info` (JSON) mit Feldern: `worst_mischfenster`, `corr_id`.
+
+---
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Installierte Python-Version ≥ 3.8
+- Zugriff auf eine Linux-Umgebung (Userspace)
+
+### Installation
+1. Repository klonen:
+   ```bash
+   git clone https://git.donau2space.de/Mika/gate_prototyp_v0
+   cd gate_prototyp_v0
+   ```
+2. Erforderliche Abhängigkeiten installieren (falls vorhanden):
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+### Nutzung
+- **Beispielausführung zur Summarizerstellung:**
+  ```bash
+  python run_summary.py --input data/raw_events.json --output summary.json
+  ```
+- **Entscheidung basierend auf Summary treffen:**
+  ```bash
+  python gate_decision.py --summary summary.json --output decision.json
+  ```
+- **Debug-Informationen erstellen:**
+  ```bash
+  python debug_artifact.py --input data/raw_events.json --output debug.json
+  ```
+
+---
+
+## Typische Use-Cases
+- Bewertung von Systemverhalten anhand von p95-Signalwerten.
+- Automatisierte Entscheidungslogik (Gate-V0-Regel) im Datensammelprozess.
+- Debugging und Performance-Analyse von Mischfenstern für statistische Verfahren.
+
+---
+
+## Struktur & mögliche Erweiterungen
+- Der bestehende Code ist modular aufgebaut und erlaubt einfache Erweiterungen durch neue Analysefunktionen oder alternative Gate-Regeln.
+- Anpassung der Datenstrukturen möglich durch Erweiterung der JSON-Schemas.
+- Integration in größere Datenpipelines durch Nutzung der vorhandenen API-Funktionen.
+
+---
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+---
+
+**Hinweis:** Diese README sowie alle begleitenden Inhalte wurden automatisiert durch ein KI-System erstellt. Verwendung erfolgt auf eigenes Risiko.