Add README.md

README.md

@@ -0,0 +1,88 @@
+# Donau Strommessung
+
+## Überblick
+Dieses Experiment (experiment_key: donau_strommessung) untersucht die elektrische Aktivität der Donau mithilfe von selbstgebauten Sensoren und dokumentiert die Messergebnisse sowie die Erfahrungen der Durchführung unter realen Bedingungen.
+
+**Link zum Artikel:** [https://donau2space.de/donau-atmet-strom-nachtmessung-an-der-staustufe/](https://donau2space.de/donau-atmet-strom-nachtmessung-an-der-staustufe/)
+
+**Git-Repository:** [https://git.donau2space.de/Mika/donau_strommessung](https://git.donau2space.de/Mika/donau_strommessung)
+
+### 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
+
+### Artefakte
+
+#### 1. sensor_logging
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprachen:** Python  
+- **Zweck:** Aufzeichnung von Messdaten der angeschlossenen Sensoren (ADS1115, DHT22) in Logdateien.  
+- **API-Funktionen:**  
+  - `log_sensor_data(voltage: float, temperature: float, humidity: float)` – schreibt Messwerte in das Logfile.  
+- **Datenstrukturen:**  
+  - `SensorData (json)` mit den Feldern: timestamp, voltage, temperature, humidity.
+
+#### 2. data_analysis
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprachen:** Python  
+- **Zweck:** Analyse der gesammelten Messdaten, Ermittlung statistischer Kenngrößen und Korrelation zwischen Spannung und Wetterparametern.  
+- **API-Funktionen:**  
+  - `analyze_data(data: List[SensorData])` – liefert einen `SummaryReport` über Spannungswerte und deren Beziehungen zu Wetterdaten.  
+- **Datenstrukturen:**  
+  - `SummaryReport (json)` mit Feldern: max_voltage, min_voltage, average_voltage, correlation_with_weather.
+
+#### 3. measurement_log
+- **Art:** csv_dataset  
+- **Ziel:** mixed  
+- **Sprache:** CSV  
+- **Zweck:** Rohdaten der Messreihen, nutzbar für weitere Auswertungen.  
+- **Struktur:**  
+  - `MeasurementLog (table)` mit Spalten: timestamp, voltage, temperature, humidity.
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Linux-System mit installiertem Python (Version ≥ 3.8)
+- Zugriff auf Sensor-Hardware (ADS1115, DHT22)
+- Schreibrechte im Projektverzeichnis für Logdateien
+
+### Installation
+1. Repository klonen:  
+   `git clone https://git.donau2space.de/Mika/donau_strommessung`
+2. In das Projektverzeichnis wechseln:  
+   `cd donau_strommessung`
+3. Abhängigkeiten installieren:  
+   `pip install -r requirements.txt`
+
+### Nutzung
+1. Sensor-Logging starten:  
+   `python sensor_logging.py`
+2. Nach Abschluss: Datenanalyse durchführen:  
+   `python data_analysis.py`
+3. Ergebnisse in Log- und Report-Dateien einsehen.
+
+## Typische Use-Cases
+- Aufzeichnen elektrischer Signale aus experimentellen Sensoraufbauten an der Donau.
+- Untersuchung von Zusammenhängen zwischen elektrischer Aktivität und Umweltparametern (Temperatur, Luftfeuchtigkeit).
+- Bereitstellen der erhobenen Daten für weitergehende wissenschaftliche Auswertungen.
+
+## Struktur & mögliche Erweiterungen
+- **sensor_logging.py** – Messdatenerfassung und Log-Erstellung.  
+- **data_analysis.py** – statistische Analyse und Ergebnisaufbereitung.  
+- **measurement_log.csv** – Sammeldatei mit Rohdaten aller Messungen.  
+
+**Erweiterbar durch:**
+- zusätzliche Sensorkomponenten (z. B. Leitfähigkeitssensoren)
+- Echtzeit-Datenvisualisierung
+- Exportformate für wissenschaftliche Publikationen
+
+## Lizenz
+Veröffentlicht unter der **MIT-Lizenz**.
+
+Die Inhalte wurden automatisch per KI generiert. Nutzung und Weiterentwicklung erfolgen auf eigenes Risiko.