TravellingSalesmanOsm

Travelling salesman problem on OpenStreetMap data. Shortest path distances by Dijkstra's algortihmn. Frontend built with react and leaflet.

This repository serves as part of an assignment at my university.

OpenStreetMap protobuf files as found on http://download.geofabrik.de/europe.html are read into an efficient internal graph representation. Solving instances of the Travelling Salesman Problem is done using the Held-Karp algorithmn with bitmasking for representation of subsets. Additionally, the Travelling Salesman problem is approximated by the 2-APX using minimum spanning trees. Since finding shortest-path distances between each target of the TSP is necessary for a good solution, this repo also provides an implementation of Dijkstra's algorithmn for this purpose. Targets can either be the current location, points of interest which are selected by category or a marker on the map. Using the functionality can be done by either interfacing the HTTP API or using the web application which is also part of this repo. The web application is built using react and leaflet. A production build of the client is already included in the codebase. Parsing the OpenStreetMap files is done using osmpbf.

Screenshots:

Installation

This installation guide focuses building the app on Ubuntu systems. Building on Windows or macOs is possible but additional steps, which are not covered by this guide, might be required to successfully build the binaries for such systems.

Prerequisities

Be sure to have Boost, protobuf at version 3.5.1 and zlib installed on your system. Boost and zlib can be installed by the following command.

sudo apt-get install libboost-all-dev zlib1g-dev

For protobuf, please follow the installation instructions on the protobuf github page.

Building the server

Please clone this repo recursively:

git clone --recurse-submodules https://github.com/marctuscher/TravellingSalesmanOsm.git

First, build the osmpbf library required for parsing the protobuf files:

cd osmpbf/
mkdir build
cd build/
cmake ..
make

As soon as this process finishes successfully, the main program can be build using

cd src/
make

in the projects root directory.

Starting

Configuring the selectable categories for POI search is done using a .json file which should have following structure:

{
    "shop": [
        "bakery", "supermarket", "mall", "kiosk", "beverages", "butcher", "deli", "dairy", "wholesale", "baby_goods", "bag", "clothes", "shoes"
    ], 
    "amenity": [
        "bar", "bbq"
    ]
}

Possible values can be found on https://wiki.openstreetmap.org/wiki/Map_Features

The application is run by issuing following commands:

cd src/
./main.out /path/to/osm/file.osm.pbf ../config.json

The frontend can now be accessed on http://localhost:8080

Client

The source code for the client web application is located in the react-client/ directory. Being able to build changes to the client requires Node. For installation, please refer to the official installation guide https://nodejs.org/en/download/

All of the following commands should only be run in the react-client subdirectory.

Creating a production build of the web application:

npm run build

Creating a development build of the web application:

npm run dev

Starting the development server:

npm start

Docker

In case you want to spend your time using this app instead of compiling it, there is also a docker image available on dockerhub.

docker pull marctuscher/travellingsalesmanosm

To run the image copy your config.json and your osm.pbf file to a folder. Now you just need to mount this folder into the container and tell the container the name of your osm.pbf file in the run command:

docker run -d -v /path/to/datafolder/:/usr/app/data -e FILENAME="yourfilename.osm.pbf" -p 8080:8080 marctuscher/travellingsalesmanosm

The appilication can now be accessed on http://localhost:8080