Add README.md
This commit is contained in:
parent
f63310fddd
commit
5887800c3f
1 changed files with 86 additions and 0 deletions
86
README.md
Normal file
86
README.md
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
# Licht im leeren Nebel
|
||||||
|
|
||||||
|
## Überblick
|
||||||
|
Experiment **licht_im_leeren_nebel** untersucht die Sichtbarkeit von Licht in einem Medium ohne Streumittel. Es beinhaltet Sensordatenerfassung, Aufzeichnung und Auswertung über separate Software-Komponenten.
|
||||||
|
|
||||||
|
**Link zum Artikel:** [https://donau2space.de/licht-im-leeren-nebel-donau2space-experiment/](https://donau2space.de/licht-im-leeren-nebel-donau2space-experiment/)
|
||||||
|
|
||||||
|
**Git Repository:** [https://git.donau2space.de/Mika/licht_im_leeren_nebel](https://git.donau2space.de/Mika/licht_im_leeren_nebel)
|
||||||
|
|
||||||
|
### 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-Skript (`logger`)
|
||||||
|
**Art:** python_script
|
||||||
|
**Ziel:** linux-demo
|
||||||
|
**Sprachen:** Python
|
||||||
|
**Zweck:** Erfasst regelmäßig Sensordaten und schreibt sie protokolliert in Logdateien.
|
||||||
|
|
||||||
|
**API-Funktion:**
|
||||||
|
- **start_logging(interval, duration)** → gibt den Pfad der erzeugten Logdatei zurück.
|
||||||
|
|
||||||
|
**Datenstruktur:**
|
||||||
|
- **LogEntry (JSON)**
|
||||||
|
- timestamp
|
||||||
|
- led_id
|
||||||
|
- lumens
|
||||||
|
- peak_wavelength
|
||||||
|
- latitude
|
||||||
|
- longitude
|
||||||
|
|
||||||
|
### 2. Datenvisualisierung (`data_visualization`)
|
||||||
|
**Art:** web_ui
|
||||||
|
**Ziel:** web
|
||||||
|
**Sprachen:** HTML, CSS, JavaScript
|
||||||
|
**Zweck:** Webanwendung zur grafischen Auswertung der Loggerdaten.
|
||||||
|
|
||||||
|
**API-Funktion:**
|
||||||
|
- **fetch_data(log_file_path)** → lädt Messdaten aus der Logdatei.
|
||||||
|
|
||||||
|
**Routen:**
|
||||||
|
- `GET /data` → liefert Loggerdaten für die Darstellung im Frontend.
|
||||||
|
|
||||||
|
### 3. Experimentbericht (`experiment_report`)
|
||||||
|
**Art:** doc_only
|
||||||
|
**Ziel:** mixed
|
||||||
|
**Zweck:** Dokumentation von Aufbau, Messergebnissen und Erkenntnissen.
|
||||||
|
|
||||||
|
## Voraussetzungen (Webserver)
|
||||||
|
Für die Webanwendung wird ein Standard-Webserver mit Unterstützung für statische Dateien (HTML, JS, CSS) benötigt. Python 3.x wird zum Ausführen des Logger-Skripts vorausgesetzt.
|
||||||
|
|
||||||
|
## Installation & Nutzung
|
||||||
|
|
||||||
|
### Installation Python-Logger
|
||||||
|
- Python 3.x installieren
|
||||||
|
- Repository klonen oder entpacken
|
||||||
|
- Abhängigkeiten mit `pip install -r requirements.txt` (falls vorhanden) installieren
|
||||||
|
- Logger starten: `python logger.py`
|
||||||
|
|
||||||
|
Parameter können im Skript oder über Umgebungsvariablen angepasst werden.
|
||||||
|
|
||||||
|
### Start der Webanwendung
|
||||||
|
- Webserver im `data_visualization`-Verzeichnis starten (z. B. `python -m http.server`)
|
||||||
|
- Browser öffnen und `http://localhost:8000` aufrufen
|
||||||
|
|
||||||
|
## Typische Use-Cases
|
||||||
|
- Aufzeichnen von optischen Messdaten mit Sensorik
|
||||||
|
- Darstellung der Messintensität über Zeit oder Position
|
||||||
|
- Vergleich von Versuchsdaten über mehrere Durchläufe
|
||||||
|
- Erstellen experimenteller Berichte für Lichtausbreitung in streulosen Medien
|
||||||
|
|
||||||
|
## Struktur & mögliche Erweiterungen
|
||||||
|
Das Repository ist modular aufgebaut:
|
||||||
|
- `logger/` – Python-Erfassungsskript
|
||||||
|
- `data_visualization/` – Weboberfläche zur Datenanalyse
|
||||||
|
- `experiment_report/` – Dokumentationsmaterialien
|
||||||
|
|
||||||
|
Erweiterungen können über zusätzliche Analyse-Skripte, Datenexportformate oder Schnittstellen zur Sensoransteuerung erfolgen.
|
||||||
|
|
||||||
|
## Lizenz
|
||||||
|
Dieses Projekt ist unter der **MIT-Lizenz** veröffentlicht.
|
||||||
|
|
||||||
|
**Hinweis:** Inhalte wurden automatisiert generiert und bereitgestellt ohne Gewähr. Nutzung erfolgt auf eigene Verantwortung.
|
||||||
Loading…
Reference in a new issue