From 880c989c032081985807f5009d3b87f765f682f2 Mon Sep 17 00:00:00 2001 From: Peter Kannewitz Date: Tue, 28 Mar 2023 15:34:38 +0200 Subject: [PATCH] added readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..470987b4 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Copbird Webside Project + +In diesem Repository sollen relavante Daten und Code für die Copbird Webseite gesammelt werden. Alle Daten befinden sich im Verzeichnis `data/`. Im Verzeichnis `ergebnisse_hackathon_repo/` befindet sich ein fork des Ergbnis-Repo vom Hackathon. Im Jupyter-Notebook `zusammenfassung.ipynb` sollten relevante Analyse Schritte Dokumentiert werden, bisher ist dort aber vornehmlich eine erneute Datenaufbereitung Dokumentiert. Zu besseren Interoperabilität, ist der Code zur Datenaufbereitung auch im Skript `merge_police_tweets.py` ausgeführt (identisch). + +## Requirements + +Um die Jupyter Umgebung dieses Repositorys zu nutzen empfiehlt sich auf die breits initialiserte nix-flake zurückzugreifen. Installationsanweisungen sind auf der Webseite https://jupyenv.io/documentation/getting-started/ Dokumentiert. Im wesentlich benötigt man: + +- einen Nix daemon +- Nix-Flakes (zu aktivieren in der nix.con) + +und kann dann `nix run` ausführen.