sqsgen 安装与使用

Posted Jun 6, 2023

By Nobody 12 min read

sqsgen 安装与使用

介绍

安装：How to install sqsgen? — sqsgenerator 0.3 documentation

命令行使用：CLI reference — sqsgenerator 0.3 documentation

多亚点阵 sqsgen 生成示例：Advanced topics — sqsgenerator 0.3 documentation

sqsgen：SQS（special quasi-random structure, 特殊准随机结构）生成程序。

目标函数为 WC 参数（warren-cowley parameter）；
生成速度相比 ATAT 及 ICET 相关模块要快，功能也更多；
10000 个原子以内的构型的 sqs 生成速度在 2min 以内；
可事先估计生成 sqs 结构所耗费时间；可计算 WC 参数等；
浓度用具体的原子数目表示，比百分比形式更方便；
有 OpenMP 和 OpenMP+MPI 两种版本。

安装

conda 直接安装

只有 OpenMP 版本

        
conda create -n sqsgen python=3.11

conda install -c conda-forge sqsgenerator

# 安装构型文件导出格式所需的package
pip install pymatgen ase

手动编译

有 OpenMP+MPI 两种版本

创建 sqsgen 的 conda 虚拟环境，安装必要的 package，并下载源码；

        
conda create -n sqsgen_mpi -c conda-forge boost boost-cpp cmake gxx_linux-64 libgomp numpy pip python=3

git clone https://github.com/dgehringer/sqsgenerator.git

OpenMP 版本 ```bash conda activate sqsgen_mpi cd sqsgenerator

SQS_Boost_INCLUDE_DIR=”${CONDA_PREFIX}/include” \
SQS_Boost_LIBRARY_DIR_RELEASE=”${CONDA_PREFIX}/lib”
CMAKE_CXX_COMPILER=”g++”
CMAKE_CXX_FLAGS=”-DNDEBUG -O2 -mtune=native -march=native”
pip install .

---

- OpenMP+MPI 版本
```bash
conda activate sqsgen_mpi
cd sqsgenerator

SQS_MPI_HOME="${HOME}/yangsl/src/openmpi" \
SQS_USE_MPI=ON \
SQS_Boost_INCLUDE_DIR="${CONDA_PREFIX}/include" \
SQS_Boost_LIBRARY_DIR_RELEASE="${CONDA_PREFIX}/lib" \
CMAKE_CXX_COMPILER="g++" \
CMAKE_CXX_FLAGS="-DNDEBUG -O2 -mtune=native -march=native" \
pip install .

注：

与官方的编译教程相比，主要的区别为 CMAKE_CXX_COMPILER 选择所在 Linux 系统的默认加载的 g++，非 conda 版本的 g++（后者编译时在自己的机器上出错）。
安装出错后，重新安装时，建议删除 sqsgenerator 目录下的新增文件 sqsgenerator/core/include/version.hpp。
python 版本也可以适当降低，如 3.9。
使用 mpirun 多核运行 sqsgen 时，不要使用 -c gz 参数，会出现 FileExistsError: [Errno 17] File exists: 'fe-is.tar.gz' 的报错。最终的 *.result.yaml 文件会覆盖成一个文件 (本应 N)。并行计算，一次生成 N 个结构（同一时间）；N 个结构之间是不同的。

源代码修改

当要构建的 sqs 原子很多时（1000 及以上），默认导出的构型文件名前缀太长（类似哈希码），会导致在 linux 系统中无法写入保存成文件（无法解压缩）

sqsgenerator/io.py 第 358 行左右

        
      
    # modified by ysl
    # for rank, structure in structures.items():
        # filename = f'{rank}.{format}'
    for i, (rank, structure) in enumerate(structures.items(), 1):
        filename = f'{i}.{format}'

使用

以下的文件内容为构建 Ti2AlNb B2 相超胞（Ti 占据一个格点，Al 和 Nb 随机占据另一个格点）。

sqsgen 程序的输入文件格式为 yaml，相关文件：

b2.vasp（初始构型文件）

# BCC(001) cell with dimension 1 x 1 x 1 and a = 3.23
  3.23000000000000
  1.00000000000000      0.00000000000000      0.00000000000000
  0.00000000000000      1.00000000000000      0.00000000000000
  0.00000000000000      0.00000000000000      1.00000000000000
  Ti      Al
   1      1
direct
  0.00000000000000      0.00000000000000      0.00000000000000
  0.50000000000000      0.50000000000000      0.50000000000000

sqs.yaml

        
      
structure:
file: b2.vasp
supercell: [4, 4, 4]
iterations: 1e7
shell_weights:
1: 1.0
2: 1.0
which: Al
composition:
Al: 32
Nb: 32

yaml 文件内容相关参数：

structure - 读取初始结构，vasp poscar 格式；
iterations - MC 迭代次数；
shell_weights - 计算目标函数 WC 参数考虑的第 N 近邻原子距离的权重；对于 BCC，考虑到第二近邻即可；
which - 选中具体的原子位点进行 mcsqs；
composition - 浓度；生成空位时，元素用数字 0 代替。

sqs 生成耗费时间估计

sqsgen compute estimated-time sqs.yaml

sqs 生成

        
# 查看帮助
sqsgen run iteration --help

sqsgen run iteration sqs.yaml -di parameters -di objective -nm -e -f lammps-data -c gz -w ase

sqsgen run iteration sqs.yaml -di parameters -di objective -nm -e -f vasp -c gz -w ase

示例

rocksalt 结构 TiN 生成 (Ti0.25Al0.25)(B0.25N0.25) 的 sqs

多亚点阵结构，Ti 和 Al 随机占据一个格点，B 和 N 随机占据另一个格点。

ti-n.cif ```plain
generated using pymatgen

data_TiN symmetry_space_group_name_H-M ‘P 1’ _cell_length_a 4.25353400 _cell_length_b 4.25353400 _cell_length_c 4.25353400 _cell_angle_alpha 90.00000000 _cell_angle_beta 90.00000000 _cell_angle_gamma 90.00000000 _symmetry_Int_Tables_number 1 _chemical_formula_structural TiN _chemical_formula_sum ‘Ti4 N4’ _cell_volume 76.95728291 _cell_formula_units_Z 4 loop symmetry_equiv_pos_site_id _symmetry_equiv_pos_as_xyz 1 ‘x, y, z’ loop _atom_site_type_symbol _atom_site_label _atom_site_symmetry_multiplicity _atom_site_fract_x _atom_site_fract_y _atom_site_fract_z _atom_site_occupancy Ti Ti0 1 0.50000000 0.00000000 0.00000000 1 Ti Ti1 1 0.50000000 0.50000000 0.50000000 1 Ti Ti2 1 0.00000000 0.00000000 0.50000000 1 Ti Ti3 1 0.00000000 0.50000000 0.00000000 1 N N4 1 0.00000000 0.00000000 0.00000000 1 N N5 1 0.00000000 0.50000000 0.50000000 1 N N6 1 0.50000000 0.00000000 0.50000000 1 N N7 1 0.50000000 0.50000000 0.00000000 1

---

- ti-al-b-n.yaml
```yaml
structure:
  supercell: [2, 2, 2]
  file: ti-n.cif
iterations: 5e5
shell_weights:
  2: 1.0
composition:
  B:
    N: 16
  N:
    N: 16
  Ti:
    Ti: 16
  Al:
    Ti: 16

composition 写法：上面的元素是要占据格点的元素，下面的元素是要被占据的元素。

运行：

        
sqsgen run iteration ti-al-b-n.yaml -di objective -di parameters -e -f vasp -w ase

sqsgen run iteration ti-al-b-n.yaml -di objective -di parameters -e -f lammps-data -w ase

注：

对于多亚点阵结构，一种元素不能同时占据两种位点，否则会报错；
要建的 sqs 超胞较大且删除的原子较多时，速度会变慢许多，可先替换原子再用 Pymatgen 删除。

FCC Al 生成 0.5-2.0% 自间隙浓度的 sqs

自间隙类型：八面体间隙；单胞中所有八面体间隙位点。

al-is-oct-all.vasp（初始构型文件）

# FCC(001) cell with dimension 1 x 1 x 1 and a = 4.05
  4.05000000000000
  1.00000000000000      0.00000000000000      0.00000000000000
  0.00000000000000      1.00000000000000      0.00000000000000
  0.00000000000000      0.00000000000000      1.00000000000000
  Al H
   4 4
direct
  0.00000000000000      0.00000000000000      0.00000000000000  Al
  0.50000000000000      0.50000000000000      0.00000000000000  Al
  0.00000000000000      0.50000000000000      0.50000000000000  Al
  0.50000000000000      0.00000000000000      0.50000000000000  Al
  0.50000000000000      0.50000000000000      0.50000000000000   H
  0.50000000000000      0.00000000000000      0.00000000000000   H
  0.00000000000000      0.50000000000000      0.00000000000000   H
  0.00000000000000      0.00000000000000      0.50000000000000   H

Al-is.yaml（输入文件） ```yaml structure: file: al-is-oct-all.vasp supercell: [10, 10, 10] iterations: 1e6 shell_weights: 1: 1.0 2: 0.5 which: H composition: Al: 20 0: 3980

---

- batch-al.sh（批处理 shell 脚本）
```shell
#!/bin/bash


execute_batch() {

    for i in ${list[*]}; do
        j=$(( i + 1 ))
        metal_total=4000
        is_total=4000
        # is_total=32000
        is_conc=${sequence[i]}
        is_num=$(echo "${metal_total}*${is_conc}*0.01" | bc | cut -d "." -f1)
        # echo $is_num
        solvent_num=$(( is_total - is_num ))
        is_con_folder=${j}-${is_conc}-percent

        if [[ ! -d $is_con_folder ]]; then
            mkdir $is_con_folder
        fi

        yaml_name=${metal_type}-is-${is_conc}-percent.yaml
        cd $is_con_folder

        struc_folder=is-struc-folder
        if [[ ! -d $struc_folder ]]; then
            mkdir $struc_folder
        fi

        case $condition_flag in
        1)
            cp ../parse_yaml.py .
            cp ../${metal_type}-is.yaml ${yaml_name}
            cp ../${metal_type}-is-oct-all.vasp .
            solvent_num_tmp=$(sed -n '11p' ${yaml_name} | awk -F': ' '{print $2}')
            is_num_tmp=$(sed -n '10p' ${yaml_name} | awk -F': ' '{print $2}')
            sed -i "11s/${solvent_num_tmp}/${solvent_num}/g" ${yaml_name}
            sed -i "10s/${is_num_tmp}/${is_num}/g" ${yaml_name}
            ;;

        2)
            sqsgen run iteration ${yaml_name} -di parameters -di objective --no-minimal -e -f lammps-data -c gz -w ase
            ;;
        3)
            tar -zxvf *.tar.gz > /dev/null 2>&1
            mv *.lammps-data $struc_folder

            python parse_yaml.py > same-is-index-count.txt

            echo "$is_con_folder parse is done."
            ;;
        *)
            echo "condition_flag is not defined!"
            ;;
        esac

        cd ..

    done

}


sequence=($(seq 0.5 0.5 2.0))
# list=(0)
# list=(3)
# list=($(seq 1 3))
list=($(seq 0 1 3))

metal_type=$1
condition_flag=$2

execute_batch $metal_type $condition_flag

parse-yaml.py（检查生成的 10 个 sqs 构型中自间隙原子坐标相同的个数） ```python import yaml import pandas as pd import numpy as np from glob import glob

def main(): # read YAML file with open(glob(“*.result.yaml”)[0], “r”) as file: data = yaml.safe_load(file)

configurations_data = data["configurations"]
is_index_list = []
for index, configuration_id in enumerate(configurations_data.keys(), 1):
    configuration_list = configurations_data[configuration_id]["configuration"]
    pd_data = pd.DataFrame(configuration_list)
    is_index = (pd_data[pd_data.iloc[:, 0] != "0"].index).to_list()

    is_index_list.append(is_index)

print("configuration 1-10 interstitial index list:")
print(np.array(is_index_list))
print("\n")

print("same interstitial index between two configuration:")
same_count_list = []
for j in range(0, 9):
    for k in range(j + 1, 10):
        common_elements = set(is_index_list[j]) & set(is_index_list[k])
        count = len(common_elements)
        same_count_list.append(count)
        print(
            f"configuration {j+1}, {k+1}, the number of same vacancy index is: {count}."
        )

count_series = pd.Series(same_count_list)
print(f"\nTotal interstitial num is {len(is_index_list[0])};")
print(count_series.describe())

if name == “main”: main()

---

## 相关问题

当需构建的 sqs 体系原子数很多时（10000+），sqsgen 程序所需的内存也很大，超算由于有内存配比限制，命令行运行时会被 kill

```bash
batch-fe.sh: line 29: 2976792 Killed                  sqsgen run iteration ${yaml_name} -di parameters -di objective --no-minimal -e -f lammps-data -c gz -w ase
slurmstepd: error: *** JOB 25428400 ON node022 CANCELLED AT 2023-05-30T19:46:40 ***
slurmstepd: error: Detected 1 oom-kill event(s) in StepId=25428400.batch. Some of your processes may have been killed by the cgroup out-of-memory handler.

科研工具, 结构建模

sqsgen

This post is licensed under CC BY 4.0 by the author.

sqsgen 安装与使用

介绍

安装

conda 直接安装

手动编译

源代码修改

使用

sqs 生成耗费时间估计

sqs 生成

示例

rocksalt 结构 TiN 生成 (Ti0.25Al0.25)(B0.25N0.25) 的 sqs

generated using pymatgen

FCC Al 生成 0.5-2.0% 自间隙浓度的 sqs

Trending Tags