Add README.md

README.md

@@ -0,0 +1,82 @@
+# Fluoreszenz unter Beton
+
+## Überblick
+Experiment „fluoreszenz_unter_beton“ zur Erfassung und Analyse von Fluoreszenzsignalen der Donau mithilfe eines USB-Spektrometers. Die Datenerfassung und -korrektur erfolgt über Python-Logger-Skripte. Das Ziel ist die zuverlässige Protokollierung, Glättung und Bereinigung von Messreihen zur weiteren wissenschaftlichen Auswertung.
+
+**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.
+
+**Link zum Artikel:** [https://donau2space.de/fluoreszenz-unter-beton-lichtsignale-der-donau/](https://donau2space.de/fluoreszenz-unter-beton-lichtsignale-der-donau/)  
+**Git Repository:** [https://git.donau2space.de/Mika/fluoreszenz_unter_beton](https://git.donau2space.de/Mika/fluoreszenz_unter_beton)
+
+## Inhalt des Repositories
+
+### 1. logger_script
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprache:** Python  
+- **Zweck:** Erfassung von Fluoreszenzsignalen über ein Spektrometer, kontinuierliches Logging in JSON-Struktur.
+
+**API-Funktionen:**
+- `start_logging(duration)` – Startet den Messvorgang für eine definierte Dauer und erzeugt Logeinträge.  
+- `flush_buffer()` – Leert den internen Puffer und schreibt Daten vollständig in das Zielverzeichnis.  
+- `moving_avg(data, window)` – Berechnet gleitende Mittelwerte zur Glättung von Datenreihen.
+
+**Datenstruktur:**
+- `log_entry` (JSON): Felder `timestamp`, `intensity`
+
+### 2. data_analysis
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprache:** Python  
+- **Zweck:** Verarbeitung, Rauschunterdrückung und Korrektur der aufgezeichneten Fluoreszenzdaten.
+
+**API-Funktionen:**
+- `correct_flourescence(raw_data)` – Führt Korrekturen der gemessenen Werte auf Basis kalibrierter Referenzkurven durch.  
+- `substract_reference(data, reference)` – Entfernt Referenzsignale, um die Netto-Fluoreszenz zu bestimmen.
+
+**Datenstruktur:**
+- `data_point` (JSON): Felder `intensity`, `background_noise`
+
+### 3. experiment_documentation
+- **Art:** doc_only  
+- **Ziel:** mixed  
+- **Sprache:** Textdokumentation  
+- **Zweck:** Enthält Aufbauanweisungen, Sicherheitsrichtlinien und Hintergrundinformationen zum Experiment.
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Linux-Umgebung mit Python ≥ 3.8  
+- USB-Spektrometer-Treiber installiert  
+- Schreibrechte im Arbeitsverzeichnis
+
+### Installation
+1. Repository klonen:  
+   `git clone https://git.donau2space.de/Mika/fluoreszenz_unter_beton.git`
+2. In das Projektverzeichnis wechseln:  
+   `cd fluoreszenz_unter_beton`
+3. Abhängigkeiten installieren:  
+   `pip install -r requirements.txt`
+
+### Ausführung
+- Logger starten:  
+  `python logger_script.py --duration 60`
+- Datenanalyse durchführen:  
+  `python data_analysis.py --input logs/data.json --output results/`
+
+## Typische Use-Cases
+- Echtzeitüberwachung von Fluoreszenzsignalen unter wechselnder Wassertrübung.  
+- Nachträgliche Signalanalyse zur Bestimmung von chemischen Veränderungen.  
+- Test von Glättungs- und Korrekturalgorithmen für Messreihen.  
+- Kalibrierung neu angeschlossener Spektrometer.
+
+## Struktur & mögliche Erweiterungen
+- Modularer Aufbau ermöglicht zusätzliche Datenauswertefunktionen.  
+- Integration weiterer Sensortypen (z. B. Temperatur- oder pH-Logger) über einheitliche API-Schnittstellen.  
+- Erweiterbar um visuelle Dashboards zur Darstellung in Echtzeit.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.  
+Die Inhalte wurden automatisch erstellt. Verwendung erfolgt ohne Gewähr und auf eigenes Risiko.