diff --git a/README.md b/README.md new file mode 100644 index 0000000..cd48637 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# EM Traces CI – Evaluierung elektromagnetischer Traces in der Continuous Integration + +## Überblick +Dieses Repository (experiment_key: **em_traces_ci**) dokumentiert die *Evaluierung der Nutzung von EM-Traces in der Continuous Integration (CI)* zur frühzeitigen Erkennung von Hochfrequenz-Anomalien. Ziel ist es, elektromagnetische Messdaten automatisiert zu erfassen, zu aggregieren und in CI-Build-Prozesse einzubetten, um Abweichungen innerhalb der Hardwareentwicklung schneller zu erkennen. + +**Link zum Artikel:** [https://donau2space.de/tag-89-1154-em-traces-in-der-ci-evaluiert-spacer-workflow-konkretisiert/](https://donau2space.de/tag-89-1154-em-traces-in-der-ci-evaluiert-spacer-workflow-konkretisiert/) + +### Hinweis +Alle Inhalte wurden per KI generiert. Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich und auf eigenes Risiko. Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert. + +## Inhalt des Repositories + +### 1. trace_agg +**Art:** Python-Skript +**Zielumgebung:** Linux-Userspace +**Sprachen:** Python +**Zweck:** Aggregation von EM-Daten mit erweiterten Metriken zur Auswertung von Messreihen. + +**API-Übersicht:** +- **Funktion:** `aggregate_em_data(num_trials)` – Aggregiert Messdaten über mehrere Versuche und erzeugt statistische Kenngrößen. + +**Datentypen:** +- **summary_statistics (JSON):** Enthält Felder `peak_amplitude`, `median_bandpower`, `crosscorr_with_clockevents`. + +### 2. em_schema +**Art:** Datenbankschema +**Zielumgebung:** Mixed (Entwicklung/Produktion) +**Sprachen:** SQL +**Zweck:** Versioniertes Schema zur Speicherung von EM-Summary-Metriken innerhalb der CI-Pipeline. + +**Datenstruktur:** +- **Tabelle:** `em_metrics` mit den Feldern `id`, `timestamp`, `peak_amplitude`, `median_bandpower`, `crosscorr_with_clockevents`. + +### 3. unit_tests +**Art:** Dokumentation +**Zielumgebung:** Mixed +**Zweck:** Beschreibung und Anforderungen für Unit-Tests des Skripts *trace_agg*. Enthält Richtlinien zur Validierung der berechneten Metriken. + +## Installation & Nutzung +1. Python-Umgebung vorbereiten (Python ≥ 3.9). +2. Abhängigkeiten installieren (`pip install -r requirements.txt`). +3. Skript ausführen: + ```bash + python trace_agg.py --input data/raw_traces/ --output results/ + ``` + +**Hinweis:** Die Pfade und Parameter sind exemplarisch und müssen an das konkrete CI-System angepasst werden. + +## Typische Use-Cases +- Integrierte Analyse elektromagnetischer Spuren in CI-Builds. +- Erkennung von HF-Anomalien während Firmware-Regressionsläufen. +- Statistische Bewertung der Hardware-Emission nach jeder Code-Änderung. + +## Struktur & mögliche Erweiterungen +- Erweiterung zusätzlicher Metriken in `trace_agg` (z. B. Frequenzbandselektion). +- Ausbau des `em_schema` um Tabellen für spektrale Vergleichsdaten. +- Integration automatischer Schwellenwertprüfung in CI-Pipelines (z. B. GitLab CI oder Jenkins). + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +*Dieses Repository und seine Inhalte wurden automatisch generiert. Nutzung und Weiterentwicklung erfolgen auf eigenes Risiko.* \ No newline at end of file