6. Installation

6.1. Clone the repository

git clone https://github.com/lyushisyan/PhonoMC.git
cd PhonoMC

6.2. Configure and build

For a release build with OpenMP:

cmake -S . -B build \
  -DCMAKE_BUILD_TYPE=Release \
  -DPHONOMC_ENABLE_OPENMP=ON \
  -DBUILD_TESTING=ON
cmake --build build -j

The executable is written to build/PhonoMC.

6.3. Run the tests

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

The test suite checks strict configuration parsing, boundary assignment and periodic pairing, the provided Cross/FinFET geometry inputs, and strict POSCAR loading.

6.4. Build without OpenMP

cmake -S . -B build -DPHONOMC_ENABLE_OPENMP=OFF
cmake --build build -j

6.5. Build the documentation

python3 -m pip install -r docs/requirements.txt
make -C docs html

Open docs/build/html/index.html in a browser.