Route Planning Project

This repo contains the starter code for the Route Planning project.

Instructions to build in Docker (By @Patrick)

1. cd into the cloned project
2. Build the docker container

docker build --tag 'cpp-dev-env' .

To use x11 inside docker on a mac see: https://stackoverflow.com/questions/37826094/xt-error-cant-open-display-if-using-default-display

This might not be necessary:

See: https://ros-developer.com/2017/11/08/docker/

xhost +local:docker

Here are the steps to prepare a socket for x11

3.1 Install socat

brew install socat

3.2 Make sure that nothing runs on port 6000 and run x11 on that port:

lsof -i TCP:6000
socat TCP-LISTEN:6000,reuseaddr,fork UNIX-CLIENT:\"$DISPLAY\"

(Keep that terminal open)

4. Finally run the docker container as shell and mount the current working directory to /CppND-Route-Planning_Project and let it connect to x11

docker run -it --mount source="$(pwd)",target="/CppND-Route-Planning_Project",type=bind -e DISPLAY=docker.for.mac.host.internal:0 cpp-dev-env 

Cloning

When cloning this project, be sure to use the --recurse-submodules flag. Using HTTPS:

git clone https://github.com/paluchs/CppND-Route-Planning-Project.git --recurse-submodules

or with SSH:

git clone git@github.com:paluchs/CppND-Route-Planning-Project.git --recurse-submodules

Compiling and Running

Compiling

To compile the project, first, create a build directory and change to that directory:

mkdir build && cd build

From within the build directory, then run cmake and make as follows:

cmake ..
make

Running

The executable will be placed in the build directory. From within build, you can run the project as follows:

./OSM_A_star_search

Or to specify a map file:

./OSM_A_star_search -f ../<your_osm_file.osm>

Testing

The testing executable is also placed in the build directory. From within build, you can run the unit tests as follows:

./test

Setting up VS Code

• Install the Dev Containers extenstion
• Install the C/C++ and the C/C++ Extension Pack
• Open the folder containing the project

Documentation from Udacity that should not be necessary with the docker setup

Dependencies for Running Locally

@Patrick: These are already installed and setup in the docker container. No need to install anything

• cmake >= 3.11.3
  • All OSes: click here for installation instructions
• make >= 4.1 (Linux, Mac), 3.81 (Windows)
  • Linux: make is installed by default on most Linux distros
  • Mac: install Xcode command line tools to get make
  • Windows: Click here for installation instructions
• gcc/g++ >= 7.4.0
  • Linux: gcc / g++ is installed by default on most Linux distros
  • Mac: same instructions as make - install Xcode command line tools
  • Windows: recommend using MinGW
• IO2D
  • Installation instructions for all operating systems can be found here
  • This library must be built in a place where CMake find_package will be able to find it

Troubleshooting

• Some students have reported issues in cmake to find io2d packages, make sure you have downloaded this.

• For MAC Users cmake issues: Comment these lines from CMakeLists.txt under P0267_RefImpl

  if( NOT DEFINED IO2D_WITHOUT_SAMPLES )
       add_subdirectory(P0267_RefImpl/Samples)
  endif()
  

  And then run "ALL_Build" and "install" in XCode.

  If any packages are missing try to install packages using

  brew install pkg-config
  

• For Ubuntu Linux IO2D installation errors, follow the given steps:

   sudo apt update
   sudo apt install build-essential
   sudo apt install cmake
   sudo apt install libcairo2-dev
   sudo apt install libgraphicsmagick1-dev
   sudo apt install libpng-dev
  
   git clone --recurse-submodules https://github.com/cpp-io2d/P0267_RefImpl
   cd P0267_RefImpl
   mkdir Debug
   cd Debug
   cmake --config Debug "-DCMAKE_BUILD_TYPE=Debug" ..
   cmake --build .
   sudo make install
  

• If you are working on windows and unable to install IO2D:

  • Enable WSL (Windows Subsystem for Linux) and use a distribution like Ubuntu.(available from the windows store):
  • Install the required dependencies (compiler, cmake etc.) in the WSL(as mentioned above for ubuntu)
  • Configure CLion to use the WSL toolchain
  • Use the WSL toolchain to build the project
  • If you are still facing errors, visit this link.

• If you are facing errors with --config try to remove -- from the command.