Add README.md

README.md

@@ -0,0 +1,97 @@
+# Transience of Dew
+
+## Überblick
+Das Experiment **transience_of_dew** untersucht die Bildung und Verdunstung von Tau auf verschiedenen Metalloberflächen über Zeit, unter kontrollierten Umweltbedingungen. Hierbei werden Sensoren zur Erfassung von Temperatur und Luftfeuchtigkeit eingesetzt und die Daten automatisch protokolliert und analysiert.
+
+**Link zum begleitenden Artikel:** [Flüssige Stille – Tau, Zeit und Messung in der Schwarzacher Bucht](https://donau2space.de/fluessige-stille-tau-zeit-und-messung-in-der-schwarzacher-bucht/)
+
+**Git-Repository:** [https://git.donau2space.de/Mika/transience_of_dew](https://git.donau2space.de/Mika/transience_of_dew)
+
+### 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. sensor_logging
+- **Art:** Python-Skript
+- **Zielsystem:** Linux Userspace
+- **Sprachen:** Python
+- **Zweck:** Erfassung und Protokollierung von Temperatur- und Feuchtigkeitswerten mithilfe von BME280-Sensoren.
+- **API-Funktion:**
+  - `log_sensor_data(sensor_id, temperature, humidity)` – schreibt Messdaten eines Sensors in das Log.
+- **Datenstruktur:**
+  - `SensorData` (JSON): sensor_id, temperature, humidity, timestamp
+
+### 2. data_analysis
+- **Art:** Python-Skript
+- **Zielsystem:** Linux Userspace
+- **Sprachen:** Python
+- **Zweck:** Analysiert gespeicherte Sensordaten, identifiziert Kondensationsmuster und berechnet statistische Werte.
+- **API-Funktion:**
+  - `analyze_condensation(data)` – führt eine Auswertung der Kondensationsdaten durch und liefert Analyseergebnisse.
+- **Datenstruktur:**
+  - `AnalysisResult` (JSON): average_diameter, condensation_rates
+
+### 3. data_export
+- **Art:** CSV-Dataset
+- **Zielsystem:** gemischt (Plattformunabhängig)
+- **Sprachen:** CSV
+- **Zweck:** Exportiert Mess- und Analyseergebnisse in standardisierte CSV-Dateien für externe Auswertung.
+- **API-Funktion:**
+  - `export_to_csv(data_list, filename)` – erstellt eine CSV-Datei aus den vorliegenden Messdaten.
+- **Datenstruktur:**
+  - `ExportData` (CSV): time, sensor_type, drop_diameter, formation_time
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Linux-System mit Python (Version ≥ 3.8)
+- Installierte BME280-Sensoren über I²C oder SPI
+- Schreibrechte an das gewünschte Datenverzeichnis
+
+### Installation
+1. Repository klonen:
+   ```bash
+   git clone https://git.donau2space.de/Mika/transience_of_dew.git
+   ```
+2. In das Projektverzeichnis wechseln:
+   ```bash
+   cd transience_of_dew
+   ```
+3. Python-Abhängigkeiten installieren:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+### Nutzung
+1. Sensor-Logging starten:
+   ```bash
+   python sensor_logging.py
+   ```
+2. Nach Abschluss eine Analyse durchführen:
+   ```bash
+   python data_analysis.py
+   ```
+3. Ergebnisse exportieren:
+   ```bash
+   python data_export.py
+   ```
+
+## Typische Use-Cases
+- Vergleich der Kondensationsgeschwindigkeit auf unterschiedlichen Metallen
+- Langzeitaufzeichnung von Temperatur- und Feuchtewerten
+- Visualisierung von Taupunktentwicklungen
+- Berechnung von Verdunstungsraten aus mehreren Zeitintervallen
+
+## Struktur & mögliche Erweiterungen
+Das Repository ist modular aufgebaut, um eine einfache Integration zusätzlicher Sensoren oder Analysemethoden zu ermöglichen. Erweiterungen können beinhalten:
+- Unterstützung neuer Sensortypen über Erweiterung von `sensor_logging`
+- Erweiterte Visualisierung und statistische Modelle in `data_analysis`
+- Zusätzliche Exportformate (z. B. JSON oder SQL) über Anpassung von `data_export`
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+Nutzung und Weiterentwicklung erfolgen auf eigenes Risiko. Alle Inhalte wurden automatisch von einer KI erstellt.