Team members: Noah Breit, Peter Giannetos, Ben Olaivar, Arin Dhawan
Group Name: HeyBeter
An overview of the structure of this respository.
- datasets: The source data files fed into program
- Documents: Documentation files such as the
results.md
file - entry: The location of the
main.cpp
file - lib: Imported libraries such as
HSLAPixel.h
andPNG.h
- src: Repository specific code used in
main.cpp
- tests: The
catch.hpp
library and a test case suite - presentation: All materials used during the presentation and the
presentation video link
.
- .gitignore: Used by git to ignore certain local files
- Makefile: Used to compile the project with
make
commands - README.md: The you are reading now ... lol
A guide on running the code in this repository. Ensure you clone the repository into the same docker container as used with the CS 225 labs and mps.
- Clone the repository:
git clone github.com/ArinDhawan/CS225_FinalProject_F22
- Nagivate into the repository:
cd CS225_FinalProject_F22
(Or whatever you named it) - Create a build folder:
mkdir build
(Make sure you are in the root of the respository!) - Navigate into the build folder:
cd build
- Run:
cmake ..
(Only do this once!) - Run:
make
- Run
./main
- Repeat steps
5
and6
every time you make changes. (Ensure you're still in /build)
A quickstart guide on changing datasets
- Complete all the steps in the Code Excecution till step 4 navigate into the build folder:
cd build
- In out main function to switch between databases, we have provided commented lines to switch between databases. (Note: For the smaller database, keep in mind the selected radius and destination)
- Run:
make
- Run:
./main
A quickstart guide on running test cases with the included test suite
- Complete all the steps in "Code Execution"
- Run:
make test
- Run:
./test