This repository will host all the code that will be part of my Master's thesis at Stony Brook University
This project was built on both MacOS and Windows 10. It has not been tested on Linux.
Please see ./system/specifications/<os>_specs.md
for more information.
Optional! If you want to pre-build into a Python environment, you can run
pip3 install -r requirements.txt
Otherwise, all Python packages are built during the run.
All code in C++ is either written using stdlib
or is included in 3rdParty
subdirectories.
Depending on your OS, you will either use
./run.sh
or
run.bat
to run the entire pipeline. You can add in arguments "clean" or "build" if you want to have a clean run or aren't sure whether all the executables are built. Here's an example:
./run.sh clean build
This will clean out the relevant data directories, rebuild the executables, and run the pipeline. Order does not matter - cleaning occurs before rebuilding if both are present.
run
calls all the other computational scripts (located in ./scripts/
) in the order listed in the pipeline. For convenience's sake, if you only wish to use or run part of the pipeline, it has been broken down modularly so you can both run and clean each part
data/README.md
for more details.<tmp>
: A Python virtualenv that is used during the runclean.(bat/sh)
: A script to clean out the files and directories before a run.requirements.txt
: A list of all necessary Python packages and their versions to run the pipeline.run.(bat/sh)
: A script to run boundary detection, optimization, and registration.