Add README.md
This commit is contained in:
parent
e9f53215d1
commit
55ef3d4073
1 changed files with 74 additions and 0 deletions
74
README.md
Normal file
74
README.md
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
# run_analysis
|
||||
|
||||
## Überblick
|
||||
Analyse der Zeitreihen-Daten für Runs und deren Metriken zur Identifikation von Δt<0-Fällen.
|
||||
|
||||
**Artikel:** [https://donau2space.de/tag-163-run-7-im-klaren-nachmittagslicht-baseline-weiterziehen-%ce%b4t/](https://donau2space.de/tag-163-run-7-im-klaren-nachmittagslicht-baseline-weiterziehen-%ce%b4t/)
|
||||
|
||||
**Git Repository:** [https://git.donau2space.de/Mika/run_analysis](https://git.donau2space.de/Mika/run_analysis)
|
||||
|
||||
### 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
|
||||
|
||||
### 1. data_analysis (Python-Skript)
|
||||
- **Art:** python_script
|
||||
- **Ziel:** linux-userspace
|
||||
- **Sprachen:** Python
|
||||
- **Zweck:** Analyse von Δt<0-Fällen und deren Ursachen in Zeitreihendaten.
|
||||
- **API-Funktion:**
|
||||
- `analyze_runs(run_data)` → Liefert Analyseergebnisse als strukturierte Daten.
|
||||
- **Datenstruktur:**
|
||||
- `RunData` (Typ: JSON) mit Feldern: `run_id`, `timestamp`, `delta_t`, `expiring_at`.
|
||||
|
||||
### 2. metric_visualization (Web-Frontend)
|
||||
- **Art:** web_ui
|
||||
- **Ziel:** Web
|
||||
- **Sprachen:** HTML, CSS, JavaScript
|
||||
- **Zweck:** Visualisierung der Analyseergebnisse aus dem Python-Skript.
|
||||
- **API-Funktion:**
|
||||
- `fetch_analysis_data()` → Lädt Analyseergebnisse als JSON.
|
||||
- **Route:**
|
||||
- `GET /api/analysis` → Liefert Analyseergebnisse.
|
||||
|
||||
### 3. csv_export (CSV-Datensatz)
|
||||
- **Art:** csv_dataset
|
||||
- **Ziel:** linux-userspace
|
||||
- **Sprachen:** CSV
|
||||
- **Zweck:** Export der Zeitreihen-Daten zur externen Analyse.
|
||||
- **API-Funktion:**
|
||||
- `export_to_csv(run_data)` → Erzeugt CSV-Datei mit Laufdaten.
|
||||
|
||||
## Voraussetzungen (Webserver / Daten)
|
||||
- Webserver mit Unterstützung für statische Dateien (z. B. nginx, Apache).
|
||||
- Browser mit aktiviertem JavaScript.
|
||||
- Python ≥ 3.9 für die Analyseskripte.
|
||||
- CSV-kompatible Umgebung (z. B. LibreOffice, pandas, Excel) zur Betrachtung der Exportdaten.
|
||||
|
||||
## Starten der Anwendung
|
||||
1. Python-Skript ausführen, um die Analyse zu generieren.
|
||||
2. Ergebnisse werden in JSON-Dateien oder CSV-Dateien gespeichert.
|
||||
3. Web-Frontend öffnen (z. B. über `index.html` im Browser), um die Daten visuell zu prüfen.
|
||||
|
||||
## Typische Use-Cases
|
||||
- Untersuchung von Runs mit negativen Δt-Werten.
|
||||
- Statistische Auswertung von Zeitreihen-Metriken.
|
||||
- Visuelle Bewertung von Trends, Anomalien oder Datenlücken.
|
||||
- Export der berechneten Daten für externe Auswertungen.
|
||||
|
||||
## Struktur & mögliche Erweiterungen
|
||||
- **analysis/**: enthält das Python-Skript `data_analysis.py` und zugehörige JSON-Daten.
|
||||
- **web/**: enthält die HTML-, CSS- und JS-Dateien der Visualisierung.
|
||||
- **data/**: umfasst den CSV-Export und Rohdaten.
|
||||
- **Erweiterungen:**
|
||||
- Einbindung zusätzlicher Analysemodule (z. B. statistische Klassifikatoren).
|
||||
- Erweiterung der Web-UI um interaktive Filter und Diagrammtypen.
|
||||
- API-Integration zur Live-Datenanalyse.
|
||||
|
||||
## Lizenz
|
||||
MIT-Lizenz.
|
||||
© Mika Code Lab – Experiment *run_analysis*.
|
||||
Nutzung auf eigene Gefahr.
|
||||
Loading…
Reference in a new issue