This is flash, a super fast BSE solver.

Install:

Use make:

To build Flash with debug flags, release flags and the documentation type in the root directory

make 

You can seperately build Flash with debug flags, release flags or the documentation seperately by typing, respectively

make debug
make release
make documentation

If you wish to make build the documentation, make sure that doxygen is installed.

The classic way

You can avoid using the Makefile and build the code with cmake

mkdir build
cd build
cmake ../dev/
cmake --build

The make commands are doing exactly that.

Run unit tests:

Run all tests:

make test

Run debug or release build tests

make test-debug
make test-release

Lint and auto-format the code:

To run first clang-tidy and then clang-format for all files, type

make linter

To run clang-tidy or thenclang-format, type, respectively

make clang-tidy
make clang-format

Requirements:

For building: - CMake > - Eigen - HDF5 - cpp-yaml - catch2 - boost For the documentation - doxygen For linting and auto formatting: - clang-tidy - clang-format