cdk1

Herzlich willkommen zu unserer Klimadaten-Challenge cdk1 zum Thema Überschwemmungen! In diesem README finden Sie alle wichtigen Informationen zu unserer Herausforderung, den Zielen und der Struktur unseres Projekts.

Projektübersicht

Im Rahmen unserer Klimadaten-Challenge haben wir uns einer wichtigen Aufgabe gestellt: Die Europäische Union möchte die Bevölkerung besser über die Risiken des Klimawandels informieren. Geplant ist eine neue Webseite, auf der Daten zur Entwicklung bestimmter Extremereignisse in Europa übersichtlich dargestellt werden.

Wir haben uns entschieden, den Fokus auf Überschwemmungen zu legen. Sowohl Fachpersonen als auch interessierte Bürger sollen mit wenigen Klicks einen Überblick über die Klimaveränderungen in für sie relevanten Regionen erhalten, abgestimmt auf ihre individuellen Bedürfnisse.

Unser Auftrag als Data Scientists war es, einen funktionsfähigen Entwurf dieser Webseite zu entwickeln und zu programmieren.

Projektstruktur

dashboard/: Enthält beide Dashboards – für die Schweiz und die Alpenräume.
- dashboard.py: Dashboard für die Schweiz.
- dashboard_alps.py: Dashboard für die Alpenräume.
data/: Beinhaltet unsere Rohdaten sowie die verarbeiteten Daten nach dem Data Wrangling.
- generated/: Verarbeitete Daten.
- source/: Rohdaten.
data_story/: Beinhaltet unsere Data Story sowie wichtige Ressourcen dafür.
data_wrangling/: Beinhaltet Dateien für das Data Wrangling.
exploration/: Beinhaltet Dateien für die Explorative Datenanalyse (EDA).

Installation

Zur Installation und Nutzung unserer Daten finden Sie alle relevanten Dateien im Verzeichnis data, insbesondere im Unterverzeichnis generated. Dort befinden sich alle von uns generierten Daten.

Wichtige Dateien Für das dashboard_alps.py, das die Alpenregionen abdeckt, benötigen Sie folgende Dateien:

Für das dashboard.py, das ausschliesslich die Schweiz anzeigt, sind folgende Dateien erforderlich:

Voraussetzungen Um das Dashboard sowie die Datenstory starten zu können, benötigen Sie Visual Studio Code (VS Code).

Schritte zur Installation

Sie können entweder unser gesamtes GitHub-Repository klonen oder nur die relevanten Dateien herunterladen. Wichtig ist, dass sich die Daten sowie die Code-Dateien im VS Code-Workspace befinden, damit alles reibungslos funktioniert.

Git LFS

Falls das Repository mit git geklont wurde, müssen die Datensets mit git lfs heruntergeladen werden. Dokumentation zur Installation von git lfs: https://git-lfs.com/

Nachdem Git LFS installiert ist und das git repository geklont ist können die Detensets mit folgendem Befehl (in der Directory vom git repository) heruntergeladen werden:

git lfs pull

Nutzung

Öffnen Sie das Terminal in VS Code, indem Sie auf Terminal > New Terminal im Menü klicken.
In der directory dashboard führen Sie folgenden Befehl aus um alle dependencies zu installieren: pip install -r requirements.txt
Geben Sie im Terminal den folgenden Befehl ein (abhängig davon, wie Ihre Hauptdatei heißt):
- Für dashboard.py:
```
python dashboard.py
```
- Für dashboard_alps.py:
```
python dashboard_alps.py
```
- Für data_story.html, öffnen sie die directory data_story/ im terminal und führen Sie folgenden Command aus um die Data Story im browser anzuzeigen:
```
open data_story.html
```
Nachdem der Code vollständig ausgeführt wurde, wird ein Link in der Form http://127.0.0.1:5000 im Terminal angezeigt.
Klicken Sie auf diesen Link, indem Sie Ctrl + Linksklick (Windows/Linux) oder Command + Linksklick (Mac) verwenden, um das Dashboard in Ihrem Browser zu öffnen.

Dokumentation

Die Informationen zu unserem Arbeitsablauf finden Sie in unserem Wiki.

Mitwirkende

Benjamin Nater
Boran Eker
Murat Kayhan

bn4t / cdk1