Add README.md

README.md

@@ -0,0 +1,79 @@
+# Neon Donau – Kosmische Klänge
+
+## Überblick
+Dieses Experiment („**neon_donau_kosmische_klaenge**“) untersucht kosmische Strahlung mithilfe von Arduino-basierten Geigerzählern. Die Messdaten werden erfasst, aufgezeichnet, sowie in Echtzeit visualisiert und als Audio umgesetzt. Das Projekt kombiniert Hardware- und Softwarekomponenten zur explorativen Datenerhebung und -darstellung.
+
+**Artikel:** [https://donau2space.de/neon-im-donautal-kosmische-klaenge-an-der-donau/](https://donau2space.de/neon-im-donautal-kosmische-klaenge-an-der-donau/)  
+**Git Repository:** [https://git.donau2space.de/Mika/neon_donau_kosmische_klaenge](https://git.donau2space.de/Mika/neon_donau_kosmische_klaenge)
+
+## 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. geiger_counter_visualizer
+- **Art:** Python-Skript  
+- **Ziel:** Mixed (Visualisierung und Steuerung)  
+- **Sprachen:** Python  
+- **Beschreibung:** Visualisiert Geigerzählerdaten in Echtzeit.  
+
+**API-Funktionen:**
+- `visualize_data(data)`: Startet die Visualisierung der eingehenden Datensätze.
+
+**Datenstrukturen:**
+- `DataPoint` (JSON): Felder `timestamp`, `count`, `frequency`
+
+#### 2. arduino_counter
+- **Art:** Arduino-Sketch (C++-Code)  
+- **Ziel:** Linux-Userspace, verbunden mit Mikrocontroller-Plattform  
+- **Sprachen:** C++  
+- **Beschreibung:** Erfasst Strahlungswerte über Geigerzähler und übermittelt sie seriell an das Python-Visualisierungsskript.
+
+**API-Funktionen:**
+- `loop()`: Hauptschleife des Arduino-Programms; liest Werte und sendet sie in festem Intervall.
+
+**Datenstrukturen:**
+- `CounterData` (struct): Felder `count`, `frequency`
+
+#### 3. data_logging
+- **Art:** CSV-Dataset  
+- **Ziel:** Linux-Demo  
+- **Sprachen:** CSV  
+- **Beschreibung:** Enthält aufgezeichnete Strahlungsdaten für Tests und Auswertungen.
+
+**Datenstruktur:**
+- `LogEntry` (Tabelle): Spalten `timestamp`, `temperature`, `count`, `frequency`
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Python ≥ 3.8
+- Arduino IDE oder PlatformIO
+- Serieller Zugriff auf das angeschlossene Messgerät
+
+### Setup-Schritte
+1. Repository klonen:
+   `git clone https://git.donau2space.de/Mika/neon_donau_kosmische_klaenge`
+2. Python-Abhängigkeiten installieren (z. B. `matplotlib`, `pandas`).
+3. Arduino-Sketch (`arduino_counter`) auf das Board laden.
+4. Python-Skript (`geiger_counter_visualizer.py`) starten.
+5. Serial-Port im Skript konfigurieren.
+
+## Typische Use-Cases
+- Live-Visualisierung des Strahlungspegels während der Messung.
+- Aufzeichnung und spätere Analyse der Strahlungsaktivität.
+- Experimentelle Kopplung von Strahlungsdaten mit Audio-Ausgabe oder Kunstprojekten.
+
+## Struktur & mögliche Erweiterungen
+- Erweiterung durch zusätzliche Sensoren (z. B. Temperatur, Druck, Feuchtigkeit).
+- Integration mit Web-UI oder Cloud-Speicherung.
+- Anpassung der Visualisierung für andere Messreihen.
+
+## Lizenz
+MIT-Lizenz.  
+Alle Inhalte und Anleitungen ohne Gewähr.  
+Verwendung, Modifikation und Weiterverbreitung sind unter Beachtung der Lizenzbedingungen erlaubt.