lammps/buildenv

LAMMPS Build Environments Docker镜像文档

一、镜像概述和主要用途

LAMMPS Build Environments 是一个预配置的 Docker 镜像，旨在简化分子动力学模拟软件 LAMMPS（Large-scale Atomic/Molecular Massively Parallel Simulator）的编译、构建与定制过程。该镜像集成了 LAMMPS 编译所需的核心依赖（如编译器、数学库、并行计算框架等），提供标准化的构建环境，支持用户快速生成自定义版本的 LAMMPS 可执行文件，无需手动配置系统级依赖。

二、核心功能和特性

2.1 预配置依赖环境

• 集成主流编译器：GCC（9+）、Clang（可选）
• 并行计算支持：MPI（OpenMPI/MPICH）、OpenMP
• 数学与科学库：FFTW、BLAS/LAPACK、CUDA Toolkit（可选，GPU版本）
• 构建工具：CMake、Make、Git

2.2 灵活的构建定制

• 支持多版本 LAMMPS 构建（从稳定版到开发版）
• 可通过环境变量或命令行参数启用/禁用特性（如 MPI、OpenMP、GPU加速）
• 集成常用扩展包（如 KIM、REAXFF、ML-Potentials）

2.3 轻量与兼容性

• 基于 Alpine/Linux 基础镜像，最小化镜像体积
• 兼容 x86_64 架构，支持主流 Linux 发行版（Ubuntu、CentOS、Debian）

三、使用场景和适用范围

3.1 科研与学术场景

• 快速编译 LAMMPS 用于分子动力学模拟（如材料科学、生物物理）
• 测试不同版本/特性对模拟性能的影响

3.2 开发与测试场景

• LAMMPS 扩展包开发（如自定义势函数、新算法）
• 跨版本兼容性验证（如从 LAMMPS-2020 迁移到 LAMMPS-2023）

3.3 自动化与教学场景

• 集成到 CI/CD 流程（如 GitHub Actions），实现 LAMMPS 构建自动化
• 教学环境中统一编译配置，避免因系统差异导致的构建失败

四、使用方法和配置说明

4.1 镜像获取

从 Docker Hub 拉取最新镜像：

bash
docker pull lammps/build-env:latest

如需指定版本（如 20230802）：

bash
docker pull lammps/build-env:20230802

4.2 基本构建流程

4.2.1 挂载本地 LAMMPS 源码

将本地 LAMMPS 源码目录（如 ~/lammps-src）挂载到容器内，通过容器编译：

bash
docker run -it --rm \
  -v ~/lammps-src:/workspace/lammps \  # 挂载本地源码目录
  -v ~/lammps-build:/workspace/build \  # 挂载输出目录（存放编译产物）
  lammps/build-env:latest \
  /bin/bash -c "cd /workspace/lammps && mkdir -p build && cd build && cmake .. && make -j4"

4.2.2 通过环境变量定制编译选项

常用环境变量说明：

示例：启用 MPI+OpenMP，编译 KIM 和 ML-Potentials 扩展包：

bash
docker run -it --rm \
  -v ~/lammps-src:/workspace/lammps \
  -v ~/lammps-build:/workspace/build \
  -e WITH_MPI=ON \
  -e WITH_OPENMP=ON \
  -e EXTRA_PACKAGES="KIM,ML-Potentials" \
  lammps/build-env:latest \
  /bin/bash -c "cd /workspace/lammps/build && cmake .. && make -j4"

4.3 自定义编译选项（CMake 参数）

如需传递 CMake 自定义参数（如指定编译器、优化选项），可直接在 cmake 命令中添加：

bash
docker run -it --rm \
  -v ~/lammps-src:/workspace/lammps \
  -v ~/lammps-build:/workspace/build \
  lammps/build-env:latest \
  /bin/bash -c "cd /workspace/lammps/build && cmake -DCMAKE_CXX_COMPILER=g++-10 -DCMAKE_BUILD_TYPE=Release .. && make -j4"

4.4 编译产物输出

编译完成后，可执行文件 lmp 会生成在挂载的输出目录（如 ~/lammps-build），直接在宿主机使用：

bash
mpirun -np 4 ~/lammps-build/lmp -in input script.lammps  # 使用 MPI 并行运行

4.5 docker-compose 配置示例

创建 docker-compose.yml 简化多参数配置：

yaml
version: '3'
services:
  lammps-build:
    image: lammps/build-env:latest
    volumes:
      - ./lammps-src:/workspace/lammps  # 本地源码目录
      - ./lammps-build:/workspace/build  # 输出目录
    environment:
      - WITH_MPI=ON
      - WITH_OPENMP=ON
      - EXTRA_PACKAGES=KIM,REAXFF
    command: >
      /bin/bash -c "cd /workspace/lammps && mkdir -p build && cd build && cmake .. && make -j$(nproc)"

启动构建：

bash
docker-compose up

五、配置参数说明

5.1 核心环境变量

5.2 扩展包启用列表

通过 EXTRA_PACKAGES 指定需编译的扩展包（逗号分隔），支持的常用包包括：

• KIM（原子间势函数接口）
• REAXFF（反应力场）
• ML-Potentials（机器学习势函数）
• ASPHERE（非球形粒子模拟）
• BODY（刚体模拟）

六、注意事项

1. GPU 支持：启用 WITH_GPU=ON 时，需确保宿主机已安装 NVIDIA Docker 运行时（nvidia-docker），并通过 --gpus all 暴露 GPU 设备：

   bash
   docker run --gpus all -it --rm ...  # 添加 --gpus 参数启用 GPU
   

2. 权限问题：挂载目录时可能因权限导致编译失败，可通过 --user $(id -u):$(id -g) 指定用户 ID 与宿主机一致：

   bash
   docker run -it --rm --user $(id -u):$(id -g) -v ~/lammps-src:/workspace/lammps ...
   

3. 源码版本兼容性：若本地源码为开发版，建议使用 lammps/build-env:dev 镜像（对应 LAMMPS 开发分支）。