Building sampik¶
System Prerequisites¶
Sampik requires a C++20 conforming compiler.
Name |
Notes |
Requirement reasons |
---|---|---|
CMake |
v3.23+ required |
Build system |
C++ compiler |
C++20 conforming |
Building software |
Kokkos |
v4.0+ |
Building software |
MPI |
MPI-3+ conforming implementation |
Communication space backend |
NCCL |
v2.0+ |
Communication space backend |
Get sampik from GitHub:
$ git clone https://github.com/dssgabriel/sampik.git
$ cd sampik
Build¶
A basic CMake configure and build:
$ cmake -S <PATH_TO_SAMPIK> \
-B <PATH_TO_BUILD_DIR> \
-DKokkosROOT=<PATH_TO_KOKKOS_INSTALL>
$ cmake --build <PATH_TO_BUILD_DIR>
Install¶
You can then install sampik using the provided install
target:
$ cmake --build <PATH_TO_BUILD_DIR> --target install
Test¶
Tests must be enabled via CMake configuration options:
$ cmake -Dsampik_ENABLE_TESTS=ON # other options...
$ cmake --build <PATH_TO_BUILD_DIR>
$ ctest --test-dir <PATH_TO_BUILD_DIR>/test