Skip to main content

Building from Source

Prerequisites

  • C++23 compiler (GCC ≥ 13, Clang ≥ 17, or MSVC ≥ 19.38)
  • CMake ≥ 3.20
  • Eigen ≥ 3.4

Clone & Build

git clone https://github.com/skigen-project/skigen.git
cd skigen

cmake -B build \
-DSKIGEN_BUILD_TESTS=ON \
-DSKIGEN_BUILD_EXAMPLES=ON \
-DSKIGEN_BUILD_BENCHMARKS=ON

cmake --build build

If Eigen is not installed system-wide, place the Eigen source tree as a sibling directory:

parent/
├── eigen/ # Eigen source tree
└── skigen/ # This repository

CMake will detect it automatically.

Run Tests

./build/tests/skigen_tests

CMake Options

OptionDefaultDescription
SKIGEN_BUILD_TESTSONBuild the test suite
SKIGEN_BUILD_BENCHMARKSOFFBuild performance benchmarks
SKIGEN_BUILD_EXAMPLESOFFBuild example programs