Installation Instructions

COVERAGE-PLAN has been tested on Ubuntu 22.04 with CMake 3.22.

Dependencies

COVERAGE-PLAN requires the following dependencies:

  • Boost (Tested with 1.82)

  • Catch (Tested with 2.13.8-1, installed via apt install on Ubuntu 22.04)

  • Eigen (Tested with 3.3)

  • Despot (Tested with API_redesign branch)

Eigen may not work after installing via apt. You may need to create a symlink in /usr/include:

cd /usr/include
sudo ln -sf eigen3/Eigen Eigen
sudo ln -sf eigen3/unsupported unsupported

Building COVERAGE-PLAN

After installing the dependencies, run the following in the root directory:

cmake -S . -B build
cmake --build build

Running Unit Tests

To run the unit tests, run the following in the root directory:

cd build/tests
./unitTests

Examples

Upon building, example files can be found in the build/apps directory.

Build the Documentation

If you want to build it locally, do the following:

  1. Install the required packages:

sudo apt install doxygen
pip install -r docs/requirements.txt

  1. Build the documentation:

cd docs
make html

  1. Look at the documentation:

cd docs
firefox build/html/index.html

Clean Documentation Build Artifacts

If you want to clean the documentation, you can run:

cd docs
make clean