Merge pull request #5 from gedankenstuecke/dockerize

Create docker image to run make.sh

Author: amandasaurus

Dockerfile

@@ -0,0 +1,65 @@
+FROM postgis/postgis:15-3.5 AS development_build
+
+RUN apt-get update \
+&& apt-get install -y --no-install-recommends \
+ ca-certificates gnupg lsb-release locales \
+ wget curl \
+ git-core unzip \
+&& locale-gen $LANG && update-locale LANG=$LANG 
+
+
+# Get packages
+RUN apt-get update \
+&& apt-get install -y --no-install-recommends \
+ make \
+ fonts-hanazono \
+ fonts-noto-cjk \
+ fonts-noto-hinted \
+ fonts-noto-unhinted \
+ fonts-unifont \
+ gdal-bin \
+ graphicsmagick \
+ liblua5.3-dev \
+ libosmium2-dev \
+ libprotozero-dev \
+ lua5.3 \
+ mapnik-utils \
+ npm \
+ osm2pgsql \
+ osmium-tool \
+ osmosis \
+ python-is-python3 \
+ python3-mapnik \
+ python3-lxml \
+ python3-psycopg2 \
+ python3-shapely \
+ python3-pip \
+ sudo \
+ vim \
+&& apt-get clean autoclean \
+&& apt-get autoremove --yes \
+&& rm -rf /var/lib/{apt,dpkg,cache,log}/
+
+RUN wget https://downloads.sourceforge.net/gs-fonts/ghostscript-fonts-std-8.11.tar.gz
+RUN tar xvf ghostscript-fonts-std-8.11.tar.gz
+RUN mkdir -p /usr/share/fonts/type1/
+RUN mv fonts/ /usr/share/fonts/type1/gsfonts
+
+# Install python libraries
+
+RUN pip install pyyaml nik4 requests
+
+# Install carto for stylesheet
+RUN npm install -g [email protected]
+
+
+COPY . /workdir
+
+RUN mkdir -p /workdir/openstreetmap-carto/data 
+RUN mkdir -p /workdir/output
+
+WORKDIR /workdir
+
+RUN chown postgres:postgres -R /workdir  
+
+USER postgres

README.md

@@ -26,12 +26,59 @@ Make a image of OSM data of an area from 2 dates, showing what was changed.
    cd osm-mapping-party-before-after
    ```
 
+### Install & use via Docker image
+
+Alternatively, if you do not want to install the whole pipeline yourself, you can run this setup in a Docker container that is ready to use.
+We start, by cloning this repository:
+
+```bash
+git clone --recurse-submodules https://github.com/amandasaurus/osm-mapping-party-before-after
+cd osm-mapping-party-before-after
+git submodule init
+git submodule update
+```
+Then we build the image that is specified in the `Dockerfile`, picking a name for the image, e.g. `before_after_builder`.
+Depending on how you installed Docker, you might have to run `sudo` for each `docker` command.
+
+ ```bash
+docker build -t before_after_builder .
+```
+
+This step needs to be run only once, and it can take a few minutes as it will download and build all the dependencies needed. 
+Once the step is finished, you can launch the container like so:
+
+```bash
+./docker_run.sh before_after_builder /full/path/to/in-out-dir/ 
+```
+
+The command takes two parameters:
+
+1. the name of the container (as specified above)
+2. a full path to a directory you want to use for accessing and writing files to from the container (i.e. Input and output files). Depending on how you installed/run Docker, this folder might need full read/write permissions for other users (e.g. run `chmod 777`). 
+
+The `docker_run.sh` command will launch the container itself, including the necessary postgres database etc.
+It will also create two virtual docker volumes (named `pgdata` and `osm_data`). 
+These volumes are used to store external data, i.e. the database contents and the `openstreetmap-carto` external files.
+
+Once the docker container is running, you can connect into it to get a bash inside to run the commands as outlined below using:
+
+```bash
+docker exec -ti map-before-after bash
+```
+
+The resulting shell puts you into the equivalent of the root of this repository, in a folder called `/workdir`. From there you can use this repository as outlined below. 
+
+All output files are saved in the `/workdir` by default, you can from there move them into `/workdir/output` inside the container to access files on your host operating system.
+
+A [ready-built image is available on Docker Hub](https://hub.docker.com/r/gedankenstuecke/osm-mapping-party-before-after).
+
 ## Usage
 
 1. Download an OSM history file (`.osh.pbf`) e.g. from [Geofabrik's internal download server](https://osm-internal.download.geofabrik.de/?landing_page=true). You will need to log in with an OSM account.
 1. Calculate the `BBOX` with [BBoxFinder.com](http://bboxfinder.com/).
     1. *Draw a rectangle*
     1. Copy the *Box* value
+    1. Make sure coordinates are in `long/lat` format (can be changed in the bottom-right)
 1. Run the following command:
     ```bash
     ./make.sh OSM_HISTORY_FILE.osh.pbf BEFORE_TIME AFTER_TIME BBOX MIN_ZOOM MAX_ZOOM

docker_run.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# run docker with correct minimal settings to mount 
+# a) postgres db 
+# b) opencarto data directory
+# c) import/export directory for files
+# and also use correct user etc
+
+# Requires 1 parameters: 1. name of the docker image, 2. full path to input/output directory
+# depending on your setup, the input/output directory needs to have `chmod 777` on the directory to work
+
+IMAGE_NAME=$1
+OUTPUT_DIR=$2
+
+
+docker run --rm -e POSTGRES_PASSWORD="unused" -v pgdata:/var/lib/postgresql/data -v osm_data:/workdir/openstreetmap-carto/data -v $OUTPUT_DIR:/workdir/output --name map-before-after $IMAGE_NAME

make.sh

@@ -84,21 +84,21 @@ if [ ! -s "$ROOT/openstreetmap-carto/project.xml" ] ; then
 
 fi
 
-if [ ! -e "$ROOT/openstreetmap-carto/.external-data-done" ] ; then
-	cd "$ROOT/openstreetmap-carto/"
-	echo "Downloading external datasets..."
-	./scripts/get-external-data.py 
-	touch .external-data-done
-	cd "$ROOT"
-fi
-
 if [ "$(psql -At -c "select count(*) from pg_database where datname = 'gis';")" = "0" ] ; then
 	echo "Creating gis database..."
 	createdb gis
 	psql -d gis -c "create extension postgis;"
 	psql -d gis -c "create extension hstore;"
 fi
 
+if [ ! -e "$ROOT/openstreetmap-carto/data/.external-data-done" ] ; then
+	cd "$ROOT/openstreetmap-carto/"
+	echo "Downloading external datasets..."
+	./scripts/get-external-data.py
+	touch data/.external-data-done
+	cd "$ROOT"
+fi
+
 if [ "$BEFORE_FILENAME" -nt "$ROOT/.$PREFIX.$TIME_BEFORE.$BBOX_COMMA.generated" ] ; then
 	cd "$ROOT/openstreetmap-carto"
 	osm2pgsql -G --hstore --style openstreetmap-carto.style --tag-transform-script openstreetmap-carto.lua -d gis "$BEFORE_FILENAME"
@@ -112,11 +112,11 @@ for ZOOM in $(seq "$MIN_ZOOM" "$MAX_ZOOM") ; do
 	if [ "$ROOT/.$PREFIX.$TIME_BEFORE.$BBOX_COMMA.generated" -nt "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png" ] ; then
 		# eventually the image is too large, so then just break out of the loop
 		echo "Generating zoom ${ZOOM} level"
-		nik4 openstreetmap-carto/project.xml "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png" -b $BBOX_SPACE -z "$ZOOM" || break
+		nik4.py openstreetmap-carto/project.xml "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png" -b $BBOX_SPACE -z "$ZOOM" || break
 		NEW="$(mktemp tmp.XXXXXX.png)"
-		gm convert "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png" -background white label:"${TIME_BEFORE}" -gravity center -append "$NEW"
-		mv "$NEW" "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png"
-		gm convert "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png" -background white label:"Data © OpenStreetMap contributors, ODbL" -gravity center -append "$NEW"
+		#gm convert "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png" -background white -label "${TIME_BEFORE}" -gravity center -append "$NEW"
+		#mv "$NEW" "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png"
+		gm convert "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png" -background white -label "${TIME_BEFORE}, data © OpenStreetMap contributors, ODbL" -gravity center -append "$NEW"
 		mv "$NEW" "$PREFIX.$TIME_BEFORE.$BBOX_COMMA.z${ZOOM}.png"
 	fi
 done
@@ -133,11 +133,11 @@ for ZOOM in $(seq "$MIN_ZOOM" "$MAX_ZOOM") ; do
 	if [ "$ROOT/.$PREFIX.$TIME_AFTER.$BBOX_COMMA.generated" -nt "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png" ] ; then
 		# eventually the image is too large, so then just break out of the loop
 		echo "Generating zoom ${ZOOM} level"
-		nik4 openstreetmap-carto/project.xml "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png" -b $BBOX_SPACE -z "$ZOOM" || break
+		nik4.py openstreetmap-carto/project.xml "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png" -b $BBOX_SPACE -z "$ZOOM" || break
 		NEW="$(mktemp tmp.XXXXXX.png)"
-		gm convert "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png" -background white -label "$TIME_AFTER" -gravity center -append "$NEW"
-		mv "$NEW" "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png"
-		gm convert "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png" -background white -label "Data © OpenStreetMap contributors, ODbL" -gravity center -append "$NEW"
+		#gm convert "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png" -background white -label "$TIME_AFTER" -gravity center -append "$NEW"
+		#mv "$NEW" "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png"
+		gm convert "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png" -background white -label "${TIME_AFTER}, data © OpenStreetMap contributors, ODbL" -gravity center -append "$NEW"
 		mv "$NEW" "$PREFIX.$TIME_AFTER.$BBOX_COMMA.z${ZOOM}.png"
 	fi
 done
@@ -155,6 +155,7 @@ for ZOOM in $(seq "$MIN_ZOOM" "$MAX_ZOOM") ; do
 	if [ "$BEFORE" -nt "$NEW_PNG" ] || [ "$AFTER" -nt "$NEW_PNG" ] ; then
 		TMP="$(mktemp tmp.XXXXXX.png)"
 		gm montage -geometry +0+0 "$BEFORE" "$AFTER" "$TMP"
+ 
 		gm convert "$TMP" -background white -label "Data © OpenStreetMap contributors, ODbL" -gravity center -append "$NEW_PNG"
 	fi