diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b2db27 --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ +# aux_comparison_freeze_band + +## Überblick +Dieses Repository dokumentiert das Experiment **aux_comparison_freeze_band**. Ziel ist der Vergleich der Systeme *aux=2* und *aux=3* anhand von Preflight-Versuchen im sogenannten Freeze-Band. Es wurden Versuchsreihen durchgeführt, logged, ausgewertet und dokumentiert. Die Ergebnisse liefern Anhaltspunkte für Parameterunterschiede und Bandbreiteneffekte zwischen den beiden Systemen. + +**Link zum Artikel:** [https://donau2space.de/tag-199-wolkendecke-als-pruefstand-aux3-bekommt-ein-zweites-freeze-band-siegel/](https://donau2space.de/tag-199-wolkendecke-als-pruefstand-aux3-bekommt-ein-zweites-freeze-band-siegel/) + +**Git Repository:** [https://git.donau2space.de/Mika/aux_comparison_freeze_band](https://git.donau2space.de/Mika/aux_comparison_freeze_band) + +### 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 umfasst drei Hauptartefakte: + +1. **logging_tool** + **Art:** python_script + **Ziel:** Linux Userspace + **Sprache:** Python + **Zweck:** Protokollierung der Preflight-Versuche mit strukturierten Log-Einträgen. + **API-Funktion:** + - `log_preflight_attempt(timestamp, measured_p, freeze_ok, setup_fingerprint, policy_hash)` – speichert einen strukturierten Log-Eintrag. + + **Datenstruktur:** + - `LogEntry` (JSON) mit Feldern: `timestamp`, `measured_p`, `freeze_ok`, `setup_fingerprint`, `policy_hash` + +2. **analysis_tool** + **Art:** python_script + **Ziel:** Linux Userspace + **Sprache:** Python + **Zweck:** Analyse der gesammelten Preflight-Daten und Berechnung statistischer Kennwerte. + **API-Funktion:** + - `analyze_results(log_entries)` – erzeugt eine Analysezusammenfassung mit statistischen Parametern. + + **Datenstruktur:** + - `AnalysisSummary` (JSON) mit Feldern: `valid`, `median`, `IQR`, `band_width`, `delta_band_width` + +3. **results_report** + **Art:** doc_only + **Ziel:** Mixed + **Sprache:** nicht anwendbar + **Zweck:** Dokumentation der Versuchsauswertung und Zusammenfassung der Ergebnisse. + +## Installation & Nutzung +### Voraussetzungen +- Linux- oder UNIX-ähnliches System +- Python 3.8 oder höher +- Zugriffsrechte zum Lesen und Schreiben von Log-Dateien + +### Installation +1. Repository klonen: + `git clone https://git.donau2space.de/Mika/aux_comparison_freeze_band` + +2. Abhängigkeiten installieren (innerhalb des Projektverzeichnisses): + `pip install -r requirements.txt` + +### Nutzung +1. **Logging ausführen:** + `python3 logging_tool.py --session preflight_2024a` + +2. **Analyse starten:** + `python3 analysis_tool.py --input logs/preflight_2024a.json` + +3. **Bericht einsehen:** + Berichtsdokument `results_report` unter `docs/` verfügbar. + +## Typische Use-Cases +- Durchführung von Datenprotokollen während Flugversuchen. +- Auswertung von Freeze-Band-Leistungskennwerten zwischen verschiedenen AUX-Systemen. +- Vergleich relativer Schwankungsbreiten zwischen Versuchskonfigurationen. +- Validierung von Sensordaten über mehrere Testreihen hinweg. + +## Struktur & mögliche Erweiterungen +Verzeichnisübersicht: + +- `logging_tool.py` – Erfassung der Daten. +- `analysis_tool.py` – Durchführung der Auswertung. +- `docs/results_report.md` – Zusammenfassung und Schlussfolgerungen. + +Erweiterungspotential: +- Automatisierte Grafikausgabe der Analyseergebnisse. +- Erweiterte Statistikfunktionen (z. B. Varianzanalysen oder Resampling). +- Integration in CI-Pipeline zur automatischen Validierung neuer Datensätze. + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +Alle Inhalte wurden automatisch durch KI erstellt. Nutzung erfolgt ausschließlich auf eigenes Risiko. \ No newline at end of file