README.md · 于要杰/Kokkos-Project-Template

# kokkos-project-template简介

本项目的目的是提供一个快速构建kokkos项目的Cmake模板。

## 1. 如何编译？

本项目已在MacOS(OX10.14.6)、Ubuntu18.04下测试通过。通过Cmake编译，建议使用3.16以上版本，g++版本大于7.0。
重新编译时，请先make clean。
首先将项目克隆到本地，命令如下：
```bash
git clone https://gitee.com/yaojieyu/kokkos-project-template.git
```
Kokkos支持多种并行编程模型（如serial、openMP、CUDA和Hip等），用户可根据情况选择编译方式。
### 1.1 串行编译与运行
```bash
# 切换的项目目录
cd kokkos-project-template
# 建立串行的build_serial文件
mkdir build_serial && cd build_serial
# 编译
cmake .. && make -j4
# 切换到项目路径下的bin文件夹
cd ../bin
# 在bin中建立软链接
ln -s ../build_serial/src/ex-1.serial ex-1.serial
# 开始运行
./ex-1.serial
```

### 1.2 OpenMP 多线程并行编译

```bash
# 切换的项目目录
cd kokkos-project-template
# 建立串行的build_openmp文件
mkdir build_openmp && cd build_openmp
# 编译
cmake -DKokkos_ENABLE_OPENMP=ON .. && make -j4
# 切换到项目路径下的bin文件夹
cd ../bin
# 在bin中建立软链接
ln -s ../build_openmp/src/ex-1.openmp ex-1.openmp
# 开始运行
./ex-1.openmp --kokkos-threads=2
```

### 3. CUDA GPU并行编译和运行

```bash
# 切换的项目目录
cd kokkos-project-template
# 建立串行的build_cuda文件
mkdir build_cuda && cd build_cuda
# 此处替换成kokkos的路径
export CXX=~/kokkos-project-template/external/kokkos/bin/nvcc_wrapper
# 编译（注意将-DKokkos_ARCH_TURING75=ON替换成相应GPU的架构）
cmake -DKokkos_ENABLE_CUDA=ON -DKokkos_ENABLE_OPENMP=ON -DKokkos_ENABLE_CUDA_LAMBDA=ON -DKokkos_ARCH_TURING75=ON -DKokkosKernels_ENABLE_TPL_CUSPARSE=OFF -DKokkosKernels_ENABLE_TPL_CUBLAS=OFF ..
# 切换到项目路径下的bin文件夹
cd ../bin
# 在bin中建立软链接
ln -s ../build_cuda/src/ex-1.cuda ex-1.cuda
# 开始运行
./ex-1.cuda
```

GPU的编译比较复杂，容易出错。如果编译未通过，请使用ccmake进入可视化图形操作，查看kokkos和kokkos kernels的配置，确定kokkos是否能找到CUDA的路径， 例如： /usr/local/cuda.

### 3. HIP等

在AMD的GPU上编译方法与CUDA类似，下面给出在Host上使用openMP并行，在AMD GPU上使用Hip的变形方法。

```shell
# 切换的项目目录
cd kokkos-project-template
# 建立串行的build_openmp文件
mkdir build_hip && cd build_hip
# 首先将CXX设置为hpicc
export CXX=/public/software/compiler/rocm/rocm-4.0.1/bin/hipcc
cmake -DKokkos_ENABLE_OPENMP=ON -DKokkos_ENABLE_HIP=ON -DKokkos_ARCH_VEGA906=ON ..
# 切换到项目路径下的bin文件夹
cd ../bin
# 在bin中建立软链接
ln -s ../build_cuda/src/ex-1.hip ex-1.hip
# 开始运行
./ex-1.hip

```

于要杰/Kokkos-Project-Template

简介

发行版

贡献者

近期动态