Basic Installation

Prerequisites:

Unix-like operating system. (Win platform is not supported now)
C++ compiler (>= c++11)
Python intepretor (libpykids.so)
Intel One API (MPI and MKL)
cmake version >= 3.17

First you should clone this project with all submodules:

git clone --recurse-submodules http://path_to_this_repository/KIDS.git 
cd KIDS
 
# if you forget the `--recurse-submodules` when you clone the repository, you can do as follows:
git clone http://path_to_this_repository/KIDS.git
cd KIDS
git submodule update --init

Here's a quick guide for installation:

mkdir build
cd build
CC=gcc CXX=g++ cmake .. -DCMAKE_BUILD_TYPE=Release
make -j8
# make install

If you prefer not to compile all components, you can specify modules in the config.json file. Note: refrain from modifying the default config.json; simply copy the file to ${CMAKE_BINARY_DIR}, and the latter will be loaded if it exists.

‍Problem Reports:

[x] internal compiler error: If you encounter the internal compiler error: Segmentation fault message, consider enlarging the swap file and trying again using the following commands:
sudo dd if=/dev/zero of=/swapfile bs=1M count=1024

sudo mkswap /swapfile

sudo swapon /swapfile

# try compile again

sudo swapoff /swapfile # don't forget to close swap file

kids requires the MKL and MPI libraries (Intel's oneAPI is recommended), which need to be manually configured in the CMakeLists.txt file.

# for example
set(CUSTOMIZED_MKL_DIR "/opt/intel/oneapi/mkl/latest/")
set(CUSTOMIZED_MPI_DIR "/opt/intel/oneapi/mpi/latest/")

You can modify cmake/FindMKLMod.cmake and cmake/FindMKLMod.cmake to suit your PC environment.

Benchmark Test

PyKIDS

rust-KIDS

Previous	Next
Home	Manual

Table of Contents

Basic Installation

Benchmark Test

PyKIDS

rust-KIDS