Version: 2025.03

NEP 操作演示

这里，我们以 MatPL 源码根目录/example/HfO2/nep_demo 为例（HfO2 训练集来源），演示 NEP 模型的训练、测试、lammps模拟以及其他功能。案例目录结构如下所示。

HfO2/
├── atom.config
├── pwdata/
└── nep_demo/
    ├── nep_test.json
    ├── nep_train.json
    ├── train.job
    └── nep_lmps/
        ├── in.lammps
        ├── lmp.config
        ├── nep_to_lmps.txt
        ├── runcpu.job
        └── rungpu.job

pwdata 目录为训练数据目录
nep_train.json 是训练 NEP 力场输入参数文件
nep_test.json 是测试 NEP 力场输入参数文件
train.job 是slurm 提交训练任务例子
nep_lmps 目录下为 NEP 力场的 lammps md例子
- 力场文件 nep_to_lmps.txt
- 初始结构 lmp.config
- 控制文件 in.lammps
- runcpu.job 和 rungpu.job 是 slurm 脚本例子

train 训练

在 nep_demo 目录下使用如下命令即可开始训练：

MatPL train nep_train.json
# 或修改环境变量之后通过slurm 提交训练任务 sbatch train.job

输入文件解释

nep_train.json 中的内容如下所示，关于 NEP 的参数解释，请参考 NEP 参数手册：

{
    "model_type": "NEP",
    "atom_type": [
        8, 72
    ],
    "optimizer": {
        "optimizer": "ADAM",
        "epochs": 30, 
        "batch_size": 1,
        "print_freq": 10,
        "train_energy": true,
        "train_force": true,
        "train_virial": true
    },

    "format": "pwmlff/npy",
    "train_data": [
        "../pwdata/init_000_50/", "../pwdata/init_002_50/", 
        "../pwdata/init_004_50/", "../pwdata/init_006_50/", 
        "../pwdata/init_008_50/", "../pwdata/init_010_50/", 
        "../pwdata/init_012_50/", "../pwdata/init_014_50/", 
        "../pwdata/init_016_50/", "../pwdata/init_018_50/", 
        "../pwdata/init_020_20/", "../pwdata/init_022_20/", 
        "../pwdata/init_024_20/", "../pwdata/init_026_20/", 
        "../pwdata/init_001_50/", "../pwdata/init_003_50/", 
        "../pwdata/init_005_50/", "../pwdata/init_007_50/", 
        "../pwdata/init_009_50/", "../pwdata/init_011_50/", 
        "../pwdata/init_013_50/", "../pwdata/init_015_30/", 
        "../pwdata/init_017_50/", "../pwdata/init_019_50/", 
        "../pwdata/init_021_20/", "../pwdata/init_023_20/", 
        "../pwdata/init_025_20/", "../pwdata/init_027_20/"
    ],
    "valid_data":[
        "../pwdata/init_000_50/", "../pwdata/init_004_50/", 
        "../pwdata/init_008_50/"       
    ]
}

训练结束后的力场文件目录请参考 model_record 详解

test 测试

test 命令支持来自 MatPL nep_model.ckpt 力场文件，以及在 lammps 或 GPUMD 中使用的 nep5.txt 格式文件。

MatPL test nep_test.json

test.json 中的内容如下所示，参数解释请参考参数手册

{
    "model_type": "NEP",
    "format": "pwmlff/npy",
    "model_load_file": "./model_record/nep_model.ckpt",
    "test_data": [
        "../init_000_50", "../init_004_50", "../init_008_50", 
        "../init_012_50", "../init_016_50", "../init_020_20", 
        "../init_024_20", "../init_001_50", "../init_005_50", 
        "../init_009_50", "../init_013_50", "../init_017_50", 
        "../init_021_20", "../init_025_20", "../init_002_50", 
        "../init_006_50", "../init_010_50", "../init_014_50", 
        "../init_018_50", "../init_022_20", "../init_026_20", 
        "../init_003_50", "../init_007_50", "../init_011_50", 
        "../init_015_30", "../init_019_50", "../init_023_20", 
        "../init_027_20"
    ]
}

测试结束后的力场文件目录请参考 test_result 详解

infer 推理单结构

infer 命令支持来自MatPL nep_model.ckpt 力场文件、GPUMD 的 nep4.txt 文件、 lammps 和 GPUMD 中通用的nep5.txt 格式文件。

MatPL infer nep_model.ckpt atom.config pwmat/config
MatPL infer gpumd_nep.txt 0.lammpstrj lammps/dump Hf O
# Hf O 为 lammps/dump格式的结构中的元素名称，Hf为结构中1号元素类型，O为元素中2号元素类型

推理成功后，将在窗口输出推理的总能、每原子能量、每原子受力和维里

其他命令

totxt

用于把 MatPL 训练的 nep_model.ckpt 文件转换为 txt 格式的nep5.txt 文件，该文件可用于 GPUMD 或 lammps-MatPL 中做分子动力学模拟。

MatPL totxt nep_model.ckpt

执行成功将在执行该命令的所在目录生成名称为nep5.txt文件

lammps MD

step1. 准备力场文件

将训练完成后生成的nep_model.ckpt力场文件用于 lammps 模拟，您需要提取力场文件，您只需要输入如下命令

MatPL totxt nep_model.ckpt

转换成功之后，您将得到一个力场文件nep5.txt。

如果您的模型正常训练结束，在model_record目录下会存在一个nep5.txt 文件，您可以直接使用。

此外，也支持 GPUMD 的 NEP5、 NEP4 力场文件。

step2. 准备输入控制文件

您需要在lammps的输入控制文件中设置如下力场，这里以HfO2为例（HfO2/nep_demo/nep_lmps

pair_style   matpl   nep_to_lmps.txt 
pair_coeff   * *     8 72

pair_style 设置力场文件路径，这里 matpl 为固定格式，代表使用MatPL中力场，nep_to_lmps.txt为力场文件路径

这里也支持多模型的偏差值输出，该功能一般用于主动学习采用中。您可以指定多个模型，在模拟中将使用第1个模型做MD，其他模型参与偏差值计算，例如例子中所示，此时pair_style设置为如下:
```
pair_style   matpl   0_nep_to_lmps.txt 1_nep_to_lmps.txt 2_nep_to_lmps.txt 3_nep_to_lmps.txt  out_freq ${DUMP_FREQ} out_file model_devi.out 
pair_coeff   * *     8 72
```
pair_coeff 指定待模拟结构中的原子类型对应的元素序号。例如，如果您的结构中 1 为 O 元素，2 为 Hf 元素，设置 pair_coeff * * 8 72即可。

这里也可以将 nep_to_lmps.txt 文件替换为您的 GPUMD 中的 NEP4 或 NEP5 力场文件。

step3 启动lammps模拟

# 加载 lammps 环境变量env.sh 文件，正确安装后，该文件位于 lammps 源码根目录下
source /the/path/of/lammps/env.sh
# 执行lammps命令
mpirun -np N lmp_mpi -in in.lammps

这里 N 为md中的使用的 CPU 核数，如果您的设备中存在可用的GPU资源（例如 M 张GPU卡）,则在运行中，N个lammps线程将平均分配到这M张卡上。我们建议您使用的 CPU 核数与您设置的 GPU 数量相同，多个线程在单个 GPU 上会由于资源竞争导致运行速度降低。

此外，lammps 接口允许跨节点以及跨节点GPU卡并行，只需要指定节点数、GPU卡数即可。

ASE 接口

NEP 模型提供了 ase 接口，使用方式如下脚本例子所示gitee 或 github。

from src.ase.calculate import MatPL_calculator
calc = MatPL(model_file='nep_model.ckpt or nep.txt')
atoms = ..... # create ase.atoms.Atoms
atoms.calc = calc # or atoms.set_calculator(calc)
energy = atoms.get_potential_energy()
forces = atoms.get_forces()
stress = atoms.get_stress()

注意，在使用本ase接口时确保已经导入了MatPL的环境变量。

NEP 操作演示

train 训练​

输入文件解释​

test 测试​

infer 推理单结构​

其他命令​

totxt​

lammps MD​

step1. 准备力场文件​

step2. 准备输入控制文件​

step3 启动lammps模拟​

ASE 接口​