Add README.md

README.md

@@ -0,0 +1,97 @@
+# Stadtatmungs-Messungen (city_breathing_measurements)
+
+## Überblick
+Das Projekt **city_breathing_measurements** untersucht das nächtliche Mikroklima einer Stadt. Es werden Lichtintensität, Temperatur und Feuchtigkeit gemessen, um lokale Klimadynamiken zu erfassen und zu analysieren.
+
+[Artikel ansehen](https://donau2space.de/fluestern-im-lichtsensor-mika-misst-das-stadtatmen/)  
+[Git Repository](https://git.donau2space.de/Mika/city_breathing_measurements)
+
+### 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. logger_setup (python_script)
+**Zweck:** Steuerung des Mikroklima-Loggers, Erfassung und Speicherung von Sensordaten.  
+**Ziel:** Linux-Userspace  
+**Sprachen:** Python
+
+**API-Funktionen:**
+- `start_logging(interval)` – Startet die Datenerfassung mit festgelegtem Intervall.
+- `save_to_csv(filename)` – Speichert die erfassten Sensordaten in einer CSV-Datei.
+
+### 2. data_analysis (python_script)
+**Zweck:** Analyse der gesammelten Daten und Erstellung von Visualisierungen.  
+**Ziel:** Linux-Userspace  
+**Sprachen:** Python
+
+**API-Funktionen:**
+- `load_data(filename)` – Lädt Sensordaten aus einer Datei und erstellt ein pandas-kompatibles DataFrame.
+- `plot_data(data)` – Erstellt Basisgrafiken zur Temperatur-, Feuchtigkeits- und Lichtauswertung.
+
+**Datenstruktur:**
+- `dataframe` – Felder: `timestamp`, `temperature`, `humidity`, `lux`
+
+### 3. data_visualization (web_ui)
+**Zweck:** Darstellung der analysierten Daten in einer webbasierten Oberfläche mit interaktiven Grafiken.  
+**Ziel:** Web  
+**Sprachen:** HTML, CSS, JavaScript
+
+**API-Routen:**
+- `GET /data` – Liefert Sensordaten zur Anzeige im Browser.
+
+**JS-Module:**
+- `chart.js (v2.9.4)` – Visualisierungskomponente für Diagramme.
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Python ≥ 3.8
+- Webbrowser
+- Optional: Webserver zur lokalen Darstellung der Weboberfläche
+
+### Installation
+1. Repository klonen:
+   ```bash
+   git clone https://git.donau2space.de/Mika/city_breathing_measurements.git
+   cd city_breathing_measurements
+   ```
+2. Python-Abhängigkeiten installieren:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+### Nutzung
+1. Mikroklima-Logger starten:
+   ```bash
+   python logger_setup.py
+   ```
+2. Daten analysieren:
+   ```bash
+   python data_analysis.py
+   ```
+3. Visualisierung starten (z. B. durch Öffnen von `web_ui/index.html` im Browser).
+
+## Typische Use-Cases
+- Erfassen und Speichern von Sensordaten in Echtzeit.
+- Analyse von Mikroklima-Trends in urbanen Gebieten.
+- Interaktive Visualisierung der gemessenen Parameter.
+
+## Struktur & mögliche Erweiterungen
+Das Repository ist modular aufgebaut:
+- **logger_setup.py** – Datenaufnahme.
+- **data_analysis.py** – Datenauswertung.
+- **data_visualization/** – Weboberfläche für interaktive Diagramme.
+
+Mögliche Erweiterungen:
+- Integration zusätzlicher Sensorparameter (z. B. CO₂, Druck).
+- Automatisierte Datensynchronisation über Netzwerk.
+- Erweiterte Filter- und Exportfunktionen in der Web-Oberfläche.
+
+## Lizenz
+Veröffentlicht unter der **MIT-Lizenz**.  
+
+---
+*Diese README-Datei wurde automatisch generiert. Alle Inhalte wurden von einer KI erstellt. Nutzung auf eigenes Risiko.*