Portable-Geo-API

This Project aims to provide an API for the calculation of road network related analysis (routing, isochrones, etc) on top of OSM data.

General Info

The API is built in Flask and utilizes PostgreSQL with the extensions PostGIS and pgRouting to perform the spatial calculations. The routing graph is created via osm2po right now as it is able to process a whole planet.pbf dump file (https://planet.osm.org/pbf/planet-latest.osm.pbf) in one run.

For portablility and ease of use the whole framework can be deployed using docker.

Installation Notes

Optional: Backup your current DB

We use pg_dump to create a dumpfile from the shell:

pg_dump --format=c --create --no-owner --no-privileges --verbose --file=/OUTPUT/PATH/FOR/YOUR/DUMPFILE.dump --dbname=YOURDATABASENAME

Graph building

We use osm2po (http://osm2po.de/) to load the data into the database.

Optional:The osm2po.config file is replaced to create a routing graph which is optimized for pedestrian routing: Modified for current version of osm2po (5.2.43): https://github.com/dkuenzel/Portable-Geo-API/blob/master/osm2po/osm2po.config (Original osm2po configuration taken from Walkers guide schema: https://raw.githubusercontent.com/scheibler/WalkersGuide-Server/master/misc/osm2po_5.0.18.config)

java -Xmx30g -jar osm2po-core-5.2.43-signed.jar prefix=world tileSize=45x45,1 ../planet-latest.osm.pbf

Create the target DB

Warning: this will delete the existing DB!!

DB="osm_routing"; 
dropdb $DB; 
createdb $DB; 

psql -d $DB -c "BEGIN; CREATE EXTENSION postgis; CREATE EXTENSION pgRouting; END;";

Data Loading

Load the osm2po output into the db in parallel (BaSH):

# target database name
DB="osm_routing"; 

# Create a common log file
logFile="/tmp/routing_sql.log"; 
rm $logFile; 
touch $logFile; 

IFS=$'\n'; 

for filename in $(ls -1 /PATH/TO/osm2po/world/*.sql); 
do 
  (psql -d osm_routing --quiet --file $filename 2>&1 | sed -e "s#^#$(date) ${filename} ($$): #g" | tee -a $logFile) & 
done;

DB optimization

The clustering might not be necessary for in-memory DBs

create index on world_2po_4pgr using gist (geom_vertex);
create index on world_2po_4pgr using gist (geom_way);
analyze world_2po_4pgr;
cluster world_2po_vertex using world_2po_vertex_geom_vertex_idx;

Client setup

1. Clone this repository to the client machine git clone https://github.com/dkuenzel/Portable-Geo-API
2. Adjust the configuration in app/settings/ to match your database setup
3. Build the docker container docker build -t routing:latest .
4. Run the docker container using port 5000 of the host docker run -p 5000:5000 -p routing:latest
5. The API documentation, query builder and sandbox should be at http://yourhost:5000