Skip to content

BuildAndTest.md

Latest commit

 

History

History
113 lines (73 loc) · 2.14 KB

BuildAndTest.md

File metadata and controls

113 lines (73 loc) · 2.14 KB

Build and Test Guide

Supported Toolchains

lindblad targets modern C++23 toolchains.

  • Windows: MSVC (Visual Studio 2022/26 recommended)
  • Linux: GCC or Clang
  • CMake: 3.20+

OpenMP support is expected and linked in lindblad_core.

Configure

From repository root:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release

Important CMake options:

  • LINDBLAD_BUILD_BENCHMARKS (default ON)
  • LINDBLAD_BUILD_PYTHON (default OFF)

Example with options:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DLINDBLAD_BUILD_BENCHMARKS=ON -DLINDBLAD_BUILD_PYTHON=OFF

Build

Windows (single-config generators)

cmake --build build -j

Windows (multi-config generators, example Release)

cmake --build build --config Release -j

Linux

cmake --build build -j$(nproc)

Test Execution

Run all discovered tests:

ctest --test-dir build --output-on-failure

For multi-config builds, specify configuration:

ctest --test-dir build -C Release --output-on-failure

Benchmark Execution

If LINDBLAD_BUILD_BENCHMARKS=ON, benchmark executables are generated from:

  • benchmarks/bench_gates.cpp
  • benchmarks/bench_statevector.cpp
  • benchmarks/bench_maqaoa.cpp

Run from the build output directory, for example:

.\bench_gates
.\bench_statevector
.\bench_maqaoa

Python Binding Build

Enable bindings:

cmake -S . -B build -DLINDBLAD_BUILD_PYTHON=ON
cmake --build build -j

This builds a lindblad Python extension module via pybind11.

Troubleshooting

Configure fails while fetching dependencies

  • Ensure outbound network access for CMake FetchContent Git repositories.
  • Remove stale build directory and reconfigure:
Remove-Item -Recurse -Force build
cmake -S . -B build

OpenMP link errors

  • Confirm compiler OpenMP support is installed/enabled.
  • On MSVC, use a Visual Studio toolchain with OpenMP components.

Tests not found in CTest

  • Verify enable_testing() and gtest_discover_tests() completed during configure.
  • Re-run CMake configure before running CTest.