diff --git a/README.md b/README.md new file mode 100644 index 0000000..d416855 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# Near Expiry Unpinned Analysis + +## Überblick +Dieses Projekt („**near_expiry_unpinned_analysis**“) untersucht die Δt<0-Problematik in Near-Expiry-Unpinned-Szenarien unter Verwendung von Datenanalyse und Visualisierung. Der Schwerpunkt liegt auf der Erfassung, Analyse und Darstellung von Messwerten aus experimentellen Zeitreihen zur Identifizierung von Ereignissen mit negativer Zeitdifferenz. + +**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. + +[Projektartikel auf donau2space.de](https://donau2space.de/tag-168-run-12-als-exakte-replikation-near-expiry-unpinned-bleibt-der-einzige-%ce%b4t/) +[Git Repository](https://git.donau2space.de/Mika/near_expiry_unpinned_analysis) + +## Inhalt des Repositories +Dieses Repository enthält drei Hauptkomponenten zur Datenerfassung, Analyse und Visualisierung. + +### 1. **data_analysis** +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprachen:** Python +- **Zweck:** Analyse von Δt<0-Fällen in Near-Expiry-Unpinned-Szenarien zur Ableitung statistischer Zusammenhänge. + +**API-Funktionen:** +- `analyze_data(data)` → Liefert ein Analyseergebnisobjekt (`analysis_result`). + +**Datenstruktur:** +- `result_summary` (JSON) mit Feldern: `near_expiry_count`, `fresh_count`, `warn_rate` + +### 2. **data_logging** +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprachen:** Python +- **Zweck:** Protokolliert Messdaten mit Δt<0-Ereignissen und exportiert Ergebnisse als CSV-Datei. + +**API-Funktionen:** +- `log_data(data, filename)` → Gibt Status der Schreiboperation zurück. + +**Datenstruktur:** +- `log_entry` (JSON) mit Feldern: `timestamp`, `value`, `status` + +### 3. **visualization_tool** +- **Art:** web_ui +- **Ziel:** Web +- **Sprachen:** HTML, CSS, JavaScript +- **Zweck:** Darstellung der Analyseergebnisse als interaktive Charts und Tabellen. + +**Routen:** +- `GET /results` → Lädt Analyseergebnisse zur Anzeige. + +**UI-/Frontend-Komponenten:** +- CSS-Komponente: `results_table` +- JS-Modul: `chart_library` + +## Installation & Nutzung +### Python-Komponenten +1. Python 3.10 oder höher installieren. +2. Benötigte Pakete installieren: + - `pip install -r requirements.txt` +3. Skripte ausführen: + - `python data_analysis.py input_data.json` + - `python data_logging.py results.csv` + +### Webinterface +1. Webserver starten (lokal oder integriert). +2. Projektverzeichnis bereitstellen. +3. Browser öffnen und auf `/results` navigieren. + +## Typische Use-Cases +- Vergleich verschiedener Δt-Messreihen aus Near-Expiry-Experimenten. +- Analyse der Häufigkeit negativer Zeitdifferenzen. +- Export von Ereignis-Logs für nachgelagerte Validierungen. +- Webbasierte Visualisierung von Ergebnissen. + +## Struktur & mögliche Erweiterungen +- **/scripts/** – Analyse- und Logging-Skripte. +- **/web/** – Weboberfläche mit Darstellungslogik. +- **/data/** – Beispiel- und Eingabedatensätze. + +**Erweiterungsvorschläge:** +- Integration zusätzlicher Analysemetriken. +- Automatisierte Datenimporter für Lab-Schnittstellen. +- Erweiterung des Webfrontends um Live-Datenstreams. + +## Lizenz +Veröffentlicht unter der **MIT-Lizenz**. +Nutzung und Weitergabe unter Beachtung der Lizenzbedingungen. + +--- +*Generierter technischer Inhalt. Nutzung auf eigenes Risiko.* \ No newline at end of file