Not Waze

Code organization

Our code is split into three components:

• create_data (src/create_data);

  Creates/Fetches graphs and saves them in a specified JSON format;

• backend (src/backend); and

  Transforms Latitude+Longitude into a node; Calculates the shortest path between two nodes; Provides an executable to try out the shortest path calculation; Provides an executable that serves a REST API;

• frontend (src/frontend).

  Provides a nice user interface that uses the aforementioned REST API (provided by the backend) to calculate the shortest paths;

Dependencies

• create_data
  • tqdm (pip install tqdm / conda install -c conda-forge tqdm)
  • networkx (pip install networkx / conda install networkx)
  • osmnx (See https://osmnx.readthedocs.io/en/stable/#installation)
• backend

  • conan (for automatic C++ dependency management)

    Note that our makefile already runs the necessary conan commands for you -- you just need to have it properly installed.

    Warning: If you are using GCC, make sure you run the "Important" box in step 5 of Conan's getting started guide, which is:

    conan profile new default --detect  # This will throw a big scary warning, but all it tells you is to run the following command:
    conan profile update settings.compiler.libcxx=libstdc++11 default

    This tells Conan to use the glibc++11 ABI. If you don't do it, then you'll have linking errors.

  • Other dependencies are automatically managed by conan.

• frontend
  • Python 3 (for launching the web server via python -m http.server)

How to run

Web Frontend

Note that in order for the servers to run, we need both the 8000 and 8080 ports to be free.

Run:

make

This will, if necessary, generate the street graph, and then serve the backend and the frontend.

Once that's done, go with your browser to localhost:8000/.

Command Line Interface

Just run

make cli

Contributors

• Daniel Csillag (@dccsillag)
• Rafael Portacio (@RafaelPortacio)
• Wellington Silva (@wellington36)