From 5847fed4be1dd9506030b964cf1bafa9d601dca9 Mon Sep 17 00:00:00 2001
From: Mika <kontakt@donau2space.de>
Date: Sun, 5 Apr 2026 02:07:43 +0000
Subject: [PATCH] Add README.md

---
 README.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9e4c6e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,103 @@
+# Stromlinien Passau Magnetfeld
+
+## Überblick
+Das Projekt **stromlinien_passau_magnetfeld** befasst sich mit der Erfassung und Analyse von magnetischen Feldern mittels präziser Magnetometer während nächtlicher Messungen im Raum Passau. Ziel ist es, lokale Schwankungen des Magnetfeldes aufzuzeichnen, zu analysieren und visuell darzustellen.
+
+**Link zum Artikel:** [https://donau2space.de/stromlinien-ueber-passau-magnetfeld-der-nacht/](https://donau2space.de/stromlinien-ueber-passau-magnetfeld-der-nacht/)  
+**Git Repository:** [https://git.donau2space.de/Mika/stromlinien_passau_magnetfeld](https://git.donau2space.de/Mika/stromlinien_passau_magnetfeld)
+
+### 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 enthält drei Hauptartefakte, die unterschiedliche Aspekte der Datenerfassung, -analyse und -visualisierung abdecken.
+
+### 1. magnetometer_data_logger
+**Art:** python_script  
+**Ziel:** linux-userspace  
+**Programmiersprache:** Python  
+**Zweck:** Erfassung und Speicherung der Magnetometerdaten in Echtzeit.
+
+**API-Funktionen:**
+- **log_data(sensor_data)** – Nimmt Sensordaten entgegen und speichert sie dauerhaft.
+
+**Datenstruktur:**
+- **SensorData (JSON):** Enthält *timestamp, Bx, By, Bz, temperature, humidity*.
+
+---
+
+### 2. data_analysis_tool
+**Art:** python_script  
+**Ziel:** linux-userspace  
+**Programmiersprache:** Python  
+**Zweck:** Analyse und Auswertung der aufgezeichneten Magnetometerdaten, Ermittlung statistischer Parameter und Anomalien.
+
+**API-Funktionen:**
+- **analyze_data(data_file)** – Führt die Analyse durch und gibt *analysis_results* zurück.
+
+**Datenstruktur:**
+- **AnalysisResults (JSON):** Beinhaltet *mean_Bx, mean_By, variance_Bx, spikes*.
+
+---
+
+### 3. data_visualization_web_ui
+**Art:** web_ui  
+**Ziel:** Web  
+**Sprachen:** HTML, CSS, JavaScript  
+**Zweck:** Darstellung der Magnetometerdaten und Analyseergebnisse in einem Browser-basierten Interface.
+
+**Routen:**
+- **GET /api/data** – Liefert die aufgezeichneten Daten als JSON.
+- **GET /api/analysis** – Liefert Analyseergebnisse als JSON.
+
+**Frontend-Komponenten:**
+- CSS-Komponente: `chart`
+- JavaScript-Modul: `chart.js`
+
+---
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Linux-Betriebssystem mit Python (>=3.8)
+- Optional: Webserver (z. B. nginx oder Apache) mit aktiviertem JavaScript-Support
+
+### Python-Skripte
+1. Repository klonen:
+   `git clone https://git.donau2space.de/Mika/stromlinien_passau_magnetfeld`
+2. In das Projektverzeichnis wechseln:
+   `cd stromlinien_passau_magnetfeld`
+3. Abhängigkeiten installieren:
+   `pip install -r requirements.txt`
+
+### Anwendung der Skripte
+- Datenerfassung starten: `python magnetometer_data_logger.py`
+- Analyse durchführen: `python data_analysis_tool.py --input <daten_datei>`
+
+### Web-UI starten
+1. Webserver starten, der das Verzeichnis `data_visualization_web_ui/` bereitstellt.
+2. Browser öffnen und auf `http://localhost:<port>` zugreifen.
+
+---
+
+## Typische Use-Cases
+- Laufende Aufzeichnung magnetischer Feldparameter in Umgebungsmessungen
+- Identifikation und Visualisierung magnetischer Störungen
+- Statistische Auswertung längerer Messzyklen
+- Exporte von Analyseergebnissen für wissenschaftliche Anwendungen
+
+---
+
+## Struktur & Erweiterbarkeit
+- **python_script-Komponenten:** Modular aufgebaut, lassen sich um zusätzliche Datensensoren oder Analyseverfahren erweitern.
+- **web_ui:** Kann durch weitere Visualisierungskomponenten ergänzt werden (z. B. Heatmaps, Zeitdiagramme).
+- Die API-Endpoints sind generisch und können in externe Dashboard-Systeme integriert werden.
+
+---
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.  
+Alle Inhalte und Skripte wurden automatisch durch ein KI-System erzeugt.  
+Verwendung und Weiterentwicklung erfolgen auf eigenes Risiko, ohne Gewährleistung oder Zusicherung der Eignung.
\ No newline at end of file