diff --git a/README.md b/README.md new file mode 100644 index 0000000..debc153 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +# BPF Spacer Experiment + +## Überblick +Das Repository **BPF_Spacer_Experiment** dokumentiert die Untersuchung der Varianz von BPF im Vergleich zu kprobe und analysiert die Auswirkung eines 0,5 mm Spacers auf HF-Amplituden. Ziel ist die statistische Validierung der Messreihen und die Quantifizierung von Veränderungen durch mechanische Distanzmodifikation. + +**Link zum Artikel:** [https://donau2space.de/tag-86-nachmittag-bpf-varianz-statistisch-bestaetigt-kurzer-spacer-probe/](https://donau2space.de/tag-86-nachmittag-bpf-varianz-statistisch-bestaetigt-kurzer-spacer-probe/) + +### 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 besteht aus drei Artefakten: + +### 1. bpf_varianz_test +- **Zweck:** Durchführung eines Levene-Tests zur Überprüfung der Varianz zwischen BPF- und kprobe-Daten. +- **Art:** Python-Skript +- **Zielplattform:** Linux Userspace +- **Sprachen:** Python + +**API-Funktionen:** +- `perform_levene_test(kprobe_samples, bpf_samples)` – Führt den Levene-Test zur Prüfung der Varianzgleichheit durch. Gibt *p_value* (float) und *is_significant* (bool) zurück. +- `bootstrap_variance_confidence_interval(samples, n_iterations)` – Berechnet Konfidenzintervalle der Varianz per Bootstrap. Gibt *ci_lower* und *ci_upper* (float) zurück. + +**Datenstrukturen:** +- `SampleData` (JSON) – Enthält das Feld *sample_values* mit den Stichprobendaten. + +### 2. spacer_measurement +- **Zweck:** Messung der HF-Amplituden von Signalen bei unterschiedlichen Spacer-Abständen. +- **Art:** Python-Skript +- **Zielplattform:** Linux Userspace +- **Sprachen:** Python + +**API-Funktionen:** +- `measure_hf_amplitude(spacer_distance, num_runs)` – Erfasst die mittlere HF-Amplitude über mehrere Läufe. Gibt *average_amplitude* (float) und *outliers_removed* (Liste) zurück. + +**Datenstrukturen:** +- `AmplitudeData` (JSON) – Enthält die Felder *amplitudes* und *outlier_count*. + +### 3. experiment_documentation +- **Zweck:** Dokumentation des gesamten Experiments, inklusive Methodik, Datenaufbereitung und Ergebnisdarstellung. +- **Art:** Dokumentation +- **Zielplattform:** Plattformunabhängig +- **Sprachen:** – + +## Installation & Nutzung +1. Python ≥ 3.9 installieren +2. Repository klonen: + + `git clone ` +3. In das Projektverzeichnis wechseln: + + `cd BPF_Spacer_Experiment` +4. Abhängigkeiten installieren: + + `pip install -r requirements.txt` +5. Skripte ausführen: + + `python bpf_varianz_test.py` + + `python spacer_measurement.py` + +Beispielaufruf für Analyse: + + `python bpf_varianz_test.py --input data/samples.json` + +## Typische Use-Cases +- Statistischer Vergleich von BPF- und kprobe-Messreihen +- Signifikanzabschätzung von Varianzänderungen bei unterschiedlichen mechanischen Setups +- Evaluation von HF-Amplituden unter variablen Distanzbedingungen + +## Struktur & mögliche Erweiterungen +- Module sind voneinander getrennt und können unabhängig ausgeführt oder in bestehende Analysepipelines integriert werden. +- Erweiterbar um zusätzliche Tests (z. B. ANOVA, F-Test) oder automatisierte Datenerfassungsskripte. +- Dokumentationsordner kann durch Bilder, Tabellen und experimentelle Rohdaten ergänzt werden. + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +--- +*Hinweis: Alle Inhalte wurden automatisch durch KI erzeugt. Nutzung auf eigene Verantwortung ohne Gewährleistung für Richtigkeit oder Eignung.* \ No newline at end of file