安装LAMMPS¶
Tip
更多细节与选项请参考手册部分。本教程采用的操作系统为Ubuntu22.04 LTS，并且已经安装GPU相关驱动。
本教程中，我们将介绍如何从源码开始编译带有GPU加速的lammps。我们将分别介绍cmake与GUN make两种编译方式。
step1: 下载源代码¶
使用git命令从Github上拉取代码
git clone https://github.com/lammps/lammps.git
或者从网站下载源代码
在官方网站上下载压缩包
step2a: 使用CMake编译LAMMPS¶
首先需要安装编译lammps所需的依赖。
apt install build-essential
apt install cmake
apt update
apt upgrade
wget https://www.fftw.org/fftw-3.3.10.tar.gz
tar zxvf fftw-3.3.10.tar.gz
cd fftw
./configure
make -j8 && make install
enable shared library
如果需要使用python接口，需要在编译时加入--enable-shared=yes参数。如果没有安装python接口, 或不编译lammps的shared lib，可以跳过这一步。
安装并行框架mpich或OpenMPI，这里以mpich为例
wget https://www.mpich.org/static/downloads/4.1.2/mpich-4.1.2.tar.gz
tar -zxvf mpich-4.1.2.tar.gz #解压缩
./configure --enable-shared=yes #--enable-shared=yes必不可少；如果安装到其他路径，注意环境变量的问题。
make -j8 && make install
CMake支持源外编辑，因此我们可以在任意位置新建一个build文件夹作为编译工作区
cd lammps #进入源码根目录
mkdir build
cd build
接下来需要选择需要编译的package。lammps预制了一些常用配置文件，位于根目录下的cmake文件夹的presets中，例如：
# lammps/cmake/presets/basic.cmake
set(ALL_PACKAGES KSPACE MANYBODY MOLECULE RIGID)
foreach(PKG ${ALL_PACKAGES})
set(PKG_${PKG} ON CACHE BOOL "" FORCE)
endforeach()
set()声明了一个名为ALL_PACKAGE 的列表，并foreach循环中，将ALL_PACKAGE的包全部选中。对于不需要额外参数的包，可以直接添加到列表中。配置完成后，通过-C指定配置文件位置，如：
cmake -C ../cmake/presets/basic.cmake ../cmake
nvidia-smi和nvcc -V命令可以运行。
请在cmake的时候加上以下参数:
-D PKG_GPU=on # include GPU package
-D GPU_API=cuda # value = opencl (default) or cuda
-D GPU_PREC=mixed # precision setting
# value = double or mixed (default) or single
-D GPU_ARCH=value # hardware choice for GPU_API=cuda
# value = sm_XX，see below
# default is Cuda-compiler dependent，but typically sm_20
-D CUDPP_OPT=value # optimization setting for GPU_API=cuda
# enables CUDA Performance Primitives Optimizations
# yes (default) or no
cmake -C ../cmake/presets/basic.cmake -DPKG_GPU=on -DGPU_API=cuda -DGPU_ARCH=sm_61 ../cmake
-D选项。
Tip
调用GPU来做加速，需要加入-sf -pk两个flag mpirun -np 8 lmp_gpu -sf gpu -pk gpu 1 -in in.file。-sf指在所有支持GPU加速的脚本命令前加上gpu前缀，-pk gpu N是GPU的数量
LAMMPS同时提供了通过ctypes到处的底层python接口和名为pylammps的高级接口。如果需要启用这个功能，需要编译名为python的包：
cmake -C ../cmake/presets/basic.cmake -DLAMMPS_EXCEPTIONS=yes -DBUILD_LIB=yes -DBUILD_SHARED_LIBS=yes ../cmake
make执行完成之后，务必使用make install-python命令安装python接口。
可以通过修改presets下的预置文件来决定哪些包需要安装。更多的参数选择请查看。待配置完成后会出现配置结果详情，如：
root@hpc-1043438:~/lammps/build# cmake -C ../cmake/presets/basic.cmake -DPKG_GPU=on -DGPU_API=cuda -DLAMMPS_EXCEPTIONS=yes -DBUILD_LIB=yes -DBUILD_SHARED_LIBS=yes ../cmake
loading initial cache file ../cmake/presets/basic.cmake
...
-- The following tools and libraries have been found and configured:
* Git
* Threads
* CUDA
* OpenMP
* Python
* Python3
-- <<< Build configuration >>>
LAMMPS Version: 20230802 patch_2Aug2023-427-g75682ffbca
Operating System: Linux Ubuntu" 20.04
CMake Version: 3.16.3
Build type: RelWithDebInfo
Install path: /root/.local
Generator: Unix Makefiles using /usr/bin/make
-- Enabled packages: GPU;KSPACE;MANYBODY;MOLECULE;RIGID
-- <<< Compilers and Flags: >>>
-- C++ Compiler: /usr/bin/c++
Type: GNU
Version: 9.4.0
C++ Flags: -O2 -g -DNDEBUG
Defines: LAMMPS_SMALLBIG;LAMMPS_MEMALIGN=64;LAMMPS_OMP_COMPAT=4;LAMMPS_GZIP;FFT_KISS;LMP_GPU
-- <<< Linker flags: >>>
-- Executable name: lmp
-- Shared library flags:
-- <<< GPU package settings >>>
-- GPU API: CUDA
-- CUDA Compiler: /usr/local/cuda/bin/nvcc
-- GPU default architecture: sm_50
-- GPU binning with CUDPP: OFF
-- CUDA MPS support: OFF
-- GPU precision: MIXED
-- <<< FFT settings >>>
-- Primary FFT lib: KISS
-- Using double precision FFTs
-- Using non-threaded FFTs
-- Configuring done
-- Generating done
-- Build files have been written to: /root/lammps/build
make -j8
make install
build文件夹下会有一个名为lmp的可执行文件，此文件为最终生成的二进制可执行文件。lmp/lmp_mpi/lmp_serial/lmp_gpu均代指此此文件。
LAMMPS中很多的style，都没有专门的cuda加速代码。这时我们可以使用kokkos库，将C++代码转化为OpenMP或者CUDA代码，在多核系统运行。在手册中，所有带有/kk前缀的命令都可以通过这个库跑在并行系统上，只需要在运行时像CUDA加上-sf kk 这样的参数即可。
因为kokkos使用了大量的新特性，因此前提是必须有C++11的编译器。安装kokkos的方法很多，我们从自动到手动来介绍。在编译的过程中，需要选择主机上是否并行和需要选择用来负责计算的设备(offload of calculations to a device)。默认这两个选项都是关闭的。此外，指定的硬件的架构必须要和本机匹配。由于硬件都是向前兼容的，所以老版本的编译出的文件可以跑在新架构上。
首先是尽量保证kokkos的GPU架构和LAMMPS的GPU包一致; 如果不一致的话，在计算开始时的初始化阶段会有一个延迟，为新硬件编译GPU核心。如果GPU的大版本不对，例如5.2和6.0这样，就会出问题。简而言之，好好设置重新编译一遍不费事，别找麻烦.
为了简化安装，在cmake/presets下有三个预配置文件:kokkos-serial.cmake，kokkos-openmp.cmake，kokkos-cuda.cmake。可以连用cmake中的-Cflage来叠加使用配置
cmake -C ../cmake/presets/basic.cmake -C ../cmake/presets/kokkos-cuda.cmake ../cmake
编译配置完成后同样使用make命令进行编译。
step2b: 使用传统的make安装¶
make是经典的编译方式，cmake最终也是使用make命令进行编译。有些情况下，系统并没有安装高版本的cmake，或者是由于cmake对于环境变量以及系统条件检测不准确，make成为了备选方案。与cmake不同的是，make编译的时候通常不采用源外编译的方式，而是直接在src文件夹下操作。在src文件夹下，使用make命令可以查看所有的编译选项。在src/MAKE文件夹下有一些预设的编译选项，可以通过make <machine>来调用。例如make serial和make mpi分别编译串行和并行的LAMMPS可执行文件。
在编译之前，你需要手动指定需要编译的包，使用make yes-<package>来添加。其中<package>是需要的包名。你可以用make package查看有哪些包需要编译。
使用以下命令可以执行默认的LAMMPS编译，在lammps/src下生成lmp_serial和lmp_mpi:
cd lammps/src
make <machine> -jN # 命令格式，-jN指用N个核编译
make serial # 编译串行的LAMMPS执行文件
make mpi # 编译并行的LAMMPS执行文件
make # 查看make帮助
编译需要很长时间，因此可以使用make <machine> -j N来并行编译。同时，安装ccache可以在重复编译时节省时间。
在第一次完成编译后，无论何时需要重新编辑LAMMPS代码、添加或删除文件，最佳实践是重新执行与原先编译相同的make <machine>命令来重新编译和链接LAMMPS可执行文件。这是因为makefile的跟踪机制只会重新编译那些需要更新的文件，因此如果对makefile进行了更改，必须重新编译整个包。如果需要清除之前的编译环境，可以使用make clean-<machine>命令。在编译之前，LAMMPS会首先收集配置信息，然后将其编入应用程序中。首次编译LAMMPS时，会生成一个工具，用于有效地检测需要重新编译的模块或源代码文件。这确保了在后续的编辑和更改过程中，只有必要的部分会被重新编译，提高了编译效率。
src/MAKE中有一些形如Makefile.<machine>的文件。使用make example以使用Makefile.example。因此，以上的make serial和make mpi分别使用了src/MAKE/Makefile.serial和src/MAKE/Makefile.mpi。其他的makefile在这些文件夹中:
OPTIONS # 关于可以用的特殊设置
MACHINES # 针对特殊的机器
MINE # 你自己的特殊设定
例如我需要指定int数据的字节数，而不是默认的4比特(21字节)。打开需要用的makefile，例如我将用make mpi命令编译，就打开Makefile.mpi，在31行找到LMP_INC关键字，在其后加上-DLAMMPS_BIGBIG，保存，回到src下使用make mpi编译。当然，多数情况下并不需要修改这些配置，因为LAMMPS会自动检测并设置。
step3: 妥善放置可执行文件¶
无论我们是采用lmp -in script.in的方式也好，mpirun -np 4 lmp -in script.in的方式执行也好，都需要将可执行文件放置在环境变量中，这样系统才可以正确地查找到可执行文件的位置。可以通过设置环境变量的方式，如export PATH=/home/.local/bin:$PATH，也可以将可执行文件放置在环境变量中的文件夹中。例如，将可执行文件放置在/usr/local/bin中，这个目录默认已经添加到环境路径中，这样系统就可以直接调用lmp命令。如果不想将可执行文件放置在环境变量中，可以使用./lmp的方式来调用可执行文件。