diff --git a/readme_md b/readme_md new file mode 100644 index 0000000..5fce469 --- /dev/null +++ b/readme_md @@ -0,0 +1,103 @@ +# Thermal Mapping Innufer + +## Überblick +Das Experiment **thermal_mapping_innufer** umfasst die Entwicklung eines Python-basierten Systems zur Erfassung, Speicherung und Analyse von Temperaturdaten. Ziel ist die Erstellung eines reproduzierbaren Workflows zur Gewinnung und Auswertung von Messwerten aus thermalen Sensoren und daraus abgeleiteten JSON-Datensätzen. + +**Link zum Artikel:** [https://donau2space.de/naechtliche-thermal-kartografie-am-innufer/](https://donau2space.de/naechtliche-thermal-kartografie-am-innufer/) + +**Git Repository:** [https://git.donau2space.de/Mika/thermal_mapping_innufer](https://git.donau2space.de/Mika/thermal_mapping_innufer) + +### 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. + +--- + +## Inhalt des Repositories +Das Repository enthält mehrere Artefakte, die gemeinsam den Gesamtworkflow der Temperaturerfassung und -analyse bilden. + +### 1. python_sensor_logger +- **Art:** python_script +- **Zielumgebung:** Linux Userspace +- **Sprache:** Python +- **Zweck:** Liest Temperaturdaten von einem angeschlossenen Sensor aus und protokolliert diese in eine Datei. + +**API-Funktionen:** +- `read_temperature()` – Ermittelt die aktuelle Temperatur in Grad Celsius. +- `log_temperature(timestamp, temperature)` – Schreibt Messdaten mit Zeitstempel in den Log. + +**Datenstruktur:** +- `TemperatureData` (JSON) mit Feldern `timestamp`, `temperature` + +### 2. temperature_data_analysis +- **Art:** python_script +- **Zielumgebung:** Linux Userspace +- **Sprache:** Python +- **Zweck:** Analysiert die erfassten Datensätze und berechnet statistische Kennwerte wie Mittelwert und Varianz. + +**API-Funktionen:** +- `analyze_temperature_data(data)` – Nimmt eine Liste von Temperaturmessungen auf und gibt Analyseergebnisse zurück. + +**Datenstruktur:** +- `AnalysisResult` (JSON) mit Feldern `mean_temperature`, `temperature_variance` + +### 3. temperature_log_dataset +- **Art:** json_dataset +- **Zielumgebung:** Mixed +- **Sprache:** JSON +- **Zweck:** Enthält alle aufgezeichneten Temperaturmessungen als Datensatz im JSON-Format. + +**Datenstruktur:** +- `TemperatureLog` mit Feldern `timestamp`, `temperature` + +--- + +## Installation & Nutzung + +### Voraussetzungen +- Python 3.8 oder höher +- Betriebssystem: Linux (getestet auf Ubuntu/Debian) + +### Installation +1. Repository klonen: + `git clone https://git.donau2space.de/Mika/thermal_mapping_innufer` +2. In das Projektverzeichnis wechseln + `cd thermal_mapping_innufer` +3. Abhängigkeiten installieren: + `pip install -r requirements.txt` + +### Ausführung +- **Sensorlogger starten:** + `python python_sensor_logger.py` + +- **Analyse durchführen:** + `python temperature_data_analysis.py` + +Diese Skripte erzeugen bzw. verarbeiten den Datensatz `temperature_log_dataset.json`. + +--- + +## Typische Use-Cases +- Überwachung der nächtlichen Temperaturentwicklung an Gewässern +- Erstellung von Thermalkarten auf Basis gemessener Daten +- Datenvorbereitung für maschinelles Lernen im Umweltkontext +- Vergleich verschiedener Sensorstandorte entlang des Flussufers + +--- + +## Struktur & Erweiterbarkeit +Das System ist modular aufgebaut und kann durch zusätzliche Sensorquellen oder Analysefunktionen erweitert werden. Die Nutzung standardisierter JSON-Datenstrukturen erlaubt einfache Integration in bestehende Datenanalyse-Pipelines. + +Mögliche Erweiterungen: +- Unterstützung weiterer Sensortypen +- Erweiterung des Analysemoduls um Zeitreihenmodelle +- Automatisierte Visualisierung der Datensätze +- Export in CSV oder Datenbankintegration + +--- + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +Nutzung, Modifikation und Weitergabe sind unter Beibehaltung des Lizenzhinweises gestattet.