diff --git a/README.md b/README.md new file mode 100644 index 0000000..82d5e6c --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# HF Offset Measurement + +## Überblick +Untersuchung von HF-Dämpfung und Offset-Variabilität durch Spacer-Matrix-Tests mit Fokus auf Software-Ursachen. + +Detaillierte Informationen und experimentelle Hintergründe sind im begleitenden Artikel beschrieben: [Tag 87 Nachmittag – Spacer-Matrix N200, HF gedämpft, 111 s Offset bleibt software-dominiert](https://donau2space.de/tag-87-nachmittag-spacer-matrix-n200-hf-gedaempft-111-s-offset-bleibt-software-dominiert/) + +### 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 +Das Repository **hf_offset_measurement** enthält Skripte und Datendateien zur Auswertung von Hochfrequenz-Messungen und Analyse von Dämpfungs- sowie Offseteffekten. + +### Artefakt-Liste + +#### 1. measurements_analysis +- **Art:** Python-Skript +- **Ziel:** Mixed +- **Sprachen:** Python +- **Zweck:** Analyse der Messdaten, Berechnung der HF-Amplitude und Variabilität. +- **API-Funktionen:** + - `analyze_measurements(data)` – Führt die Analyse der Eingabedaten durch und gibt ein Analyseergebnis zurück. +- **Datenstrukturen:** + - `MeasurementData (json)` mit Feldern: `spacing_mm`, `hf_amplitude`, `spike_outlier_rate`, `levenes_test_p` + +#### 2. report_generator +- **Art:** Python-Skript +- **Ziel:** Mixed +- **Sprachen:** Python +- **Zweck:** Erstellung eines Berichts über die Testergebnisse inklusive Plots und statistischer Kennzahlen. +- **API-Funktionen:** + - `generate_report(analysis_results)` – Generiert einen Bericht basierend auf Analyseergebnissen. +- **Datenstrukturen:** + - `ReportData (json)` mit Feldern: `title`, `content`, `plots` + +#### 3. data_export +- **Art:** CSV-Datensatz +- **Ziel:** Mixed +- **Sprachen:** CSV +- **Zweck:** Export der Messdaten zur externen Analyse. +- **API-Funktionen:** + - `export_data(data)` – Erzeugt eine CSV-Datei mit den analysierten Daten. + +## Installation & Nutzung +1. Python-Umgebung (≥3.9) installieren. +2. Abhängigkeiten installieren (z. B. pandas, numpy, matplotlib). +3. Skripte ausführen: + - `python measurements_analysis.py` für Datenauswertung. + - `python report_generator.py` für Berichtserstellung. +4. Export der Ergebnisse über `data_export.csv`. + +## Typische Use-Cases +- Untersuchung der HF-Dämpfung bei variablen Abständen. +- Analyse von softwarebedingtem Offset-Verhalten. +- Erstellung von Berichten zur Dokumentation von Messreihen. +- Export von Analyseergebnissen zur Weiterverarbeitung. + +## Struktur & Erweiterbarkeit +Das Projekt ist modular aufgebaut: +- **analysis**: Bearbeitung und Auswertung von Messdaten. +- **reporting**: Berichtsgenerierung und Visualisierung. +- **export**: Datenausgabe im CSV-Format. + +Erweiterungen können durch zusätzliche Analyseskripte oder Schnittstellenmodule erfolgen, die direkt auf die bestehenden Datenstrukturen zugreifen. + +## Lizenz +Veröffentlicht unter der **MIT-Lizenz**. + +Alle Inhalte wurden automatisch durch ein KI-System erzeugt. Keine Gewähr für Richtigkeit oder Eignung für spezifische Anwendungen. \ No newline at end of file