Add readme_markdown

This commit is contained in:
Mika 2026-02-08 03:06:34 +00:00
parent 5d9352853d
commit 8750dedce4

91
readme_markdown Normal file
View file

@ -0,0 +1,91 @@
# Echo der Wellen
## Überblick
Das Experiment **echo_der_wellen** befasst sich mit der Entwicklung von akustischen und visuellen Artefakten zur Darstellung von Gravitationswellen und deren Wechselwirkung mit der Umgebung. Ziel ist es, Sensordaten zu erfassen, aufzubereiten und sowohl akustisch als auch visuell erfahrbar zu machen.
[Projektartikel (externer Link)](https://donau2space.de/echo-der-wellen-akustische-gravitationskunst/)
[Git Repository](https://git.donau2space.de/Mika/echo_der_wellen)
## 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
Das Repository enthält drei Hauptartefakte:
### 1. data_logger
- **Art:** python_script
- **Ziel:** linux-userspace
- **Sprachen:** Python
- **Zweck:** Sammeln und Speichern von Sensordaten in CSV-Format.
- **API-Funktion:**
- `log_sensor_data(sensor_values)`: Speichert die Sensordaten in einer CSV-Datei.
- **Datenstruktur:**
- `SensorData` (JSON): timestamp, temperature, vibration_amplitude, humidity
### 2. audio_visualizer
- **Art:** python_script
- **Ziel:** linux-userspace
- **Sprachen:** Python
- **Zweck:** Visualisierung von Audiofrequenzen auf Basis der erfassten Sensordaten.
- **API-Funktion:**
- `generate_visualization(audio_file)`: Erzeugt eine visuelle Darstellung der Audiofrequenzen.
### 3. data_exporter
- **Art:** csv_dataset
- **Ziel:** linux-userspace
- **Sprachen:** CSV
- **Zweck:** Export der gesammelten Messdaten für nachgelagerte Analysen und Dokumentation.
- **API-Funktion:**
- `export_to_csv(data)`: Exportiert die bereitgestellten Daten in eine CSV-Datei.
## Installation & Nutzung
### Anforderungen
- Linux-System mit installiertem Python 3.8 oder höher
- Abhängigkeiten: `pandas`, `matplotlib`, `numpy`
### Installation
1. Repository klonen:
```bash
git clone https://git.donau2space.de/Mika/echo_der_wellen.git
cd echo_der_wellen
```
2. Virtuelle Umgebung erstellen und aktivieren:
```bash
python3 -m venv venv
source venv/bin/activate
```
3. Abhängigkeiten installieren:
```bash
pip install -r requirements.txt
```
### Nutzung
- Daten erfassen:
```bash
python data_logger.py
```
- Audio-Visualisierung erzeugen:
```bash
python audio_visualizer.py input_audio.wav
```
- Daten exportieren:
Nutzung als Bestandteil einer Analyse-Pipeline oder manuell über Script-Import.
## Typische Use-Cases
- Aufzeichnung physikalischer Sensordaten in Echtzeit
- Analyse von Vibrations- und Temperaturmustern
- Erzeugung visueller Darstellungen aus Geräusch- oder Schwingungsdaten
- Export vorbereiteter Datensätze für Forschungsanalysen
## Struktur & mögliche Erweiterungen
Das Projekt ist modular aufgebaut. Jedes Python-Skript erfüllt eine klar abgegrenzte Funktion. Weitere Module können durch Hinzufügen neuer Python-Skripte in denselben Datenfluss integriert werden:
- Erweiterung durch neue Sensortypen (z.B. Magnetometer)
- Unterstützung zusätzlicher Exportformate (z.B. JSON oder SQL)
- Visualisierung komplexerer Datensätze über zusätzliche Darstellungsalgorithmen
## Lizenz
Dieses Projekt steht unter der **MIT-Lizenz**.
Die Inhalte wurden automatisiert durch KI erstellt. Nutzung und Weiterentwicklung erfolgen auf eigene Verantwortung.