diff --git a/README.md b/README.md new file mode 100644 index 0000000..faffdfd --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# Donau2Space Experiment + +## Überblick +Das Projekt **donau2space_experiment** untersucht Langzeitbelichtung und Datenaufnahme in extrem lichtarmen Umgebungen. Ziel ist die Erfassung und Analyse von Umweltdaten (Temperatur, Windgeschwindigkeit) und die Verarbeitung von Bilddaten durch Python-Skripte. Die Ergebnisse werden über eine Weboberfläche visualisiert. + +**Link zum Artikel:** [https://donau2space.de/stille-ueber-passau-donau2space-experiment/](https://donau2space.de/stille-ueber-passau-donau2space-experiment/) + +**Git-Repository:** [https://git.donau2space.de/Mika/donau2space_experiment](https://git.donau2space.de/Mika/donau2space_experiment/) + +### 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. data_logging (Python-Skript) +- **Zweck:** Protokolliert Umweltdaten wie Temperatur und Windgeschwindigkeit während des Experiments. +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprachen:** Python +- **API-Funktionen:** + - `log_data(timestamp, temperature, wind_speed)`: Schreibt Umweltdaten in ein JSON-Log. +- **Datenstruktur:** + - `log_entry`: JSON-Objekt mit Feldern *timestamp*, *temperature*, *wind_speed*. + +### 2. image_processing (Python-Skript) +- **Zweck:** Analysiert und verarbeitet experimentelle Bilddaten durch einen Stacking-Algorithmus. +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprachen:** Python +- **API-Funktionen:** + - `process_images(image_list)`: Führt Bild-Stapelanalyse aus und liefert ein zusammengesetztes Bild. +- **Datenstruktur:** + - `image_data`: JSON-Objekt mit *frame_id*, *mean_noise*, *mean_lum*. + +### 3. data_visualization (Web-UI) +- **Zweck:** Darstellung und Auswertung der gesammelten Daten über einen Browser. +- **Art:** web_ui +- **Ziel:** Web +- **Sprachen:** HTML, CSS, JavaScript +- **Routen:** + - `GET /data` – Liefert protokollierte Umweltdaten als JSON. + - `GET /images` – Liefert analysierte Bilddaten als URLs. + +## Installation & Nutzung + +### Voraussetzungen +- Linux (getestet auf Ubuntu/Debian-basierten Systemen) +- Python ≥ 3.9 +- Webserver (z. B. Nginx oder Apache) für die Weboberfläche + +### Build & Installation +1. Repository klonen: + ```bash + git clone https://git.donau2space.de/Mika/donau2space_experiment.git + cd donau2space_experiment + ``` +2. Python-Abhängigkeiten installieren: + ```bash + pip install -r requirements.txt + ``` +3. Datenlogger und Bildverarbeitung starten: + ```bash + python data_logging.py + python image_processing.py + ``` +4. Weboberfläche bereitstellen: + - Dateien im Ordner `web_ui/` in den Webserver-Root legen. + - Server starten und im Browser öffnen. + +## Typische Use-Cases +- Automatische Erfassung und Speicherung von Temperatur- und Winddaten +- Verarbeitung und Kombination mehrerer Langzeitbelichtungen +- Visualisierung von Mess- und Bilddaten über einen Webbrowser + +## Struktur & Erweiterbarkeit +- **data_logging.py** – Sensordatenerfassung und JSON-Protokollierung +- **image_processing.py** – Verarbeitung der aufgenommenen Bilder +- **web_ui/** – HTML-/JS-basierte Visualisierung + +Erweiterungen: +- Einbindung weiterer Sensorarten (z. B. Feuchtigkeit, Luftdruck) +- Erweiterung der Bildanalyse durch Rauschreduktion oder Farbkorrektur +- Integration einer Datenbank zur Persistenzhistorie + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +--- +*Hinweis:* Alle Inhalte basieren auf KI-generierten Vorlagen. Nutzung auf eigenes Risiko. \ No newline at end of file