surface-construct 0.9.1__tar.gz → 0.9.3__tar.gz

{surface_construct-0.9.1/surface_construct.egg-info → surface_construct-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: surface_construct
-Version: 0.9.1
+Version: 0.9.3
 Summary: Surface termination construction especially for complex model, such as oxides or carbides.
 Home-page: https://gitee.com/pjren/surface_construct/
 Author: ren
@@ -28,13 +28,15 @@ Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 
-# 基于分层采样策略的催化剂表面位点全局分析
+# 催化剂表面位点和反应分子构象综合采样
 
-A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalyst Surface Composed of Multiple Sites
+催化剂构效关系是建立表面位点结构和反应过程势能面的关联关系，这依赖对表面上各种可能位点的充分分析和采样，找到这些位点对关键反应步骤的影响情况。从催化剂的角度看，研究的目标是从表面上存在的位点中找到表面最适合反应的位点，即使反应势能面最低的位点；从反应的角度看，研究目标是对于一系列反应通道，找到反应势能面上的卡点，找到能够突破卡点的催化环境。
 
+本软件同时进行表面位点的构建、采样、计算、分析，和反应过程的分析采样，即过渡态和分子构象，由此可以实现分子在表面反应的全过程采样。其中的技术关键是采样的效率，我们针对性地使用综合使用了多样化的采样策略，保证表面各类型位点和关键位点的充分采样。
 
 
-![表面位点全局分析](docs/surface_distribution_3d.jpg)
+
+<img src="docs/birds_view.png" alt="表面位点全局分析" style="zoom:50%;" />
 
 
 
@@ -42,7 +44,7 @@ A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalys
 
 
 
-![flowchart](docs/flowchart2.jpg)
+![flowchart](docs/modules-计算流程.jpg)
 
 ## 重要的概念 Glossary
 
@@ -60,143 +62,23 @@ A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalys
 
   * 当前我们使用多点定位 Multilateration 进行向量化
 
-    ![multilateration](docs/multilateration.jpg)
+    <img src="docs/multilateration.jpg" alt="multilateration" style="zoom:50%;" />
 
 * 分层采样 Stratified sampling。根据“相似结构具有相似性质”的原理采样分层采样的策略对表面位点进行采样，降低计算量。
 
   ![stratified sampling](docs/stratified_sampling.jpg)
 
-* 吸附结构
+* 表面分子结构采样。表面的分子自由度分解为表面位点+分子姿态+分子內自由度。针对它们采用不同的采样策略。
 
-  ![adsorption structure](docs/adsorption_structure.jpg)
+  <img src="docs/adsorption_structure.jpg" alt="adsorption structure" style="zoom:50%;" />
 
-## 安装
+## 安装 Installation
 
 `pip install -U surface-construct`
 
-## 发布新版本 （only for 管理员）
-
-python -m build
-twine upload --verbose dist/*
-
-## 使用方法 Manual
-
-### 所需文件 Required Files
-
-* `surface_reaction_sample.py`: 主流程文件
-
-* `parameter.py`: 参数定义文件
-
-* `POSCAR.0`: 表面结构文件
-
-  * 注意：名字可以修改，与 `parameter.py` 设置一致
-  * 设置需要固定的原子
-
-* bsub 文件。在公司集群上提交，以下面的为例
-
-  ```Bash
-  #/bin/bash
-  #BSUB -J Sampling
-  #BSUB -q short
-  #BSUB -n 28
-  #BSUB -o out.%J.txt
-  #BSUB -e error.%J.txt
-  #BSUB -R span[ptile=28]
-  module load old/intel18u4
-  export OMP_NUM_THREADS=1
-  export I_MPI_ADJUST_REDUCE=3
-  workdir=`pwd`
-  date
-  
-  export PATH="/export/home/renpengju/miniconda3/bin:$PATH"
-  export VASP_PP_PATH=$HOME/vasp/mypps
-  export VASP_SCRIPT=$workdir/run_vasp.py
-  
-  cat > run_vasp.py << EOF
-  import os
-  exitcode = os.system('mpirun -PSM2 /export/soft_old/vasp541/vasp.5.4.1/bin/vasp_gam')
-  EOF
-  
-  python surface_reaction_sample.py > surface_reaction_sample.py.log
-  
-  date
-  ```
-
-### 参数设置 
-
-注意：所有的参数均在 `parameter.py` 进行设置
-
-```python
-from ase.calculators.vasp import Vasp
-import numpy as np
-
-# 用户参数，以下参数必须设定，没有默认值
-poscar = 'ru_0001_POSCAR'
-atomnum = [7, 7]  # 吸附的原子序号， 第一个原子靠近表面
-bondlength = 1.65  # 初始的键长
-angle = [np.pi / 2, 0.0]  # 分子吸附的角度，[theta, phi_x]: [与 z 轴的角度，绕 z 轴的旋转角度(相对于x)]
-
-# 以下参数可选，具有默认值
-calc = Vasp(
-    xc='PBE',
-    gga='PE',
-    kpts=(1, 1, 1),
-    encut=400,
-    setups='recommended',
-    ncore=4,
-    gamma=True,
-    nelm=200,
-    algo='fast',
-    ismear=0,
-    sigma=0.05,
-    ibrion=-1,  # 不使用 vasp 自身的优化，必须是 -1
-    ediff=1e-4,
-    prec='normal',
-    nsw=0,  # 不使用 vasp 优化，必须是 0
-    lreal='Auto',
-    lwave=True,  # 保存 WAVECAR 可以加速
-    lcharg=False,
-    ispin=1)
-
-scan_type = 'transition_state'  # 扫描类型：'optimization'，'transition_state'
-grid_interval = 0.1  # angstrom, 格点的间距
-Nsample = 5  # 第一次采样的点
-Niter = 3  # 最大迭代次数
-fmax = 0.1  # 结构优化 force 的收敛标准
-max_error = 0.01  # 表面采样的收敛标准
-radii_type = 'covalent_radii'  # 半径选项：'vdw_radii'，'covalent_radii'
-radii_factor = 1.1  # 原子半径系数
-sampleproperty = {'phi_x': np.linspace(0, np.pi/3, 2, endpoint=False)}
-```
-
-### 手动添加格点能量信息
-
-通过脚本 `append_sample.py`实现，打开之后，修改以下信息
-
-```python
-pkl_filename = 'surface_grid.pkl'
-keep_old_sample = True  # 判断是否保留原有的采样的点
-results = [
-    '0_opt.traj',  # 支持 ase.traj, vasprun.xml 文件，仅读取最后优化后的结果
-    '1_opt.traj',
-    '2_opt.traj',
-    '3_opt.traj',
-    '4_opt.traj',
-    '5_opt.traj',
-    '6_opt.traj',
-    '7_opt.traj',
-    '8_opt.traj',
-    '9_opt.traj',
-]
-```
-
-运行: `python append_sample.py`
-
-注意：文件夹下必须有 `parameter.py` 和相应的表面结构文件
-
-注意：为了避免失误，再运行前对 `surface_grid.pkl` 进行备份
-
+## 使用方法 Tutorial
 
+参考例子 CuO_Cu_interface_LASP
 
 ### [其他 ASE 优化算法](https://wiki.fysik.dtu.dk/ase/ase/optimize.html)
 
@@ -271,8 +153,11 @@ $$
 * v 0.6: 新的高效表面格点构造，支持表面和团簇
 * v 0.7: 新的 grid_sample 方法，包含 Hull.vertices VIP 位点。 
 * v 0.8: 孔材料体系格点构造
+* v 0.9: 重新梳理软件的模块，优化软件使用逻辑
+  * v 0.9.2: debug 支持三斜晶系的表面格点化
 
 **TODO**
+
 * 表面位点数据库
 * 多原子体系（内坐标受限体系）
 * 完善用户界面、例子、教程

{surface_construct-0.9.1 → surface_construct-0.9.3}/README.md

@@ -1,10 +1,12 @@
-# 基于分层采样策略的催化剂表面位点全局分析
+# 催化剂表面位点和反应分子构象综合采样
 
-A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalyst Surface Composed of Multiple Sites
+催化剂构效关系是建立表面位点结构和反应过程势能面的关联关系，这依赖对表面上各种可能位点的充分分析和采样，找到这些位点对关键反应步骤的影响情况。从催化剂的角度看，研究的目标是从表面上存在的位点中找到表面最适合反应的位点，即使反应势能面最低的位点；从反应的角度看，研究目标是对于一系列反应通道，找到反应势能面上的卡点，找到能够突破卡点的催化环境。
 
+本软件同时进行表面位点的构建、采样、计算、分析，和反应过程的分析采样，即过渡态和分子构象，由此可以实现分子在表面反应的全过程采样。其中的技术关键是采样的效率，我们针对性地使用综合使用了多样化的采样策略，保证表面各类型位点和关键位点的充分采样。
 
 
-![表面位点全局分析](docs/surface_distribution_3d.jpg)
+
+<img src="docs/birds_view.png" alt="表面位点全局分析" style="zoom:50%;" />
 
 
 
@@ -12,7 +14,7 @@ A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalys
 
 
 
-![flowchart](docs/flowchart2.jpg)
+![flowchart](docs/modules-计算流程.jpg)
 
 ## 重要的概念 Glossary
 
@@ -30,143 +32,23 @@ A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalys
 
   * 当前我们使用多点定位 Multilateration 进行向量化
 
-    ![multilateration](docs/multilateration.jpg)
+    <img src="docs/multilateration.jpg" alt="multilateration" style="zoom:50%;" />
 
 * 分层采样 Stratified sampling。根据“相似结构具有相似性质”的原理采样分层采样的策略对表面位点进行采样，降低计算量。
 
   ![stratified sampling](docs/stratified_sampling.jpg)
 
-* 吸附结构
+* 表面分子结构采样。表面的分子自由度分解为表面位点+分子姿态+分子內自由度。针对它们采用不同的采样策略。
 
-  ![adsorption structure](docs/adsorption_structure.jpg)
+  <img src="docs/adsorption_structure.jpg" alt="adsorption structure" style="zoom:50%;" />
 
-## 安装
+## 安装 Installation
 
 `pip install -U surface-construct`
 
-## 发布新版本 （only for 管理员）
-
-python -m build
-twine upload --verbose dist/*
-
-## 使用方法 Manual
-
-### 所需文件 Required Files
-
-* `surface_reaction_sample.py`: 主流程文件
-
-* `parameter.py`: 参数定义文件
-
-* `POSCAR.0`: 表面结构文件
-
-  * 注意：名字可以修改，与 `parameter.py` 设置一致
-  * 设置需要固定的原子
-
-* bsub 文件。在公司集群上提交，以下面的为例
-
-  ```Bash
-  #/bin/bash
-  #BSUB -J Sampling
-  #BSUB -q short
-  #BSUB -n 28
-  #BSUB -o out.%J.txt
-  #BSUB -e error.%J.txt
-  #BSUB -R span[ptile=28]
-  module load old/intel18u4
-  export OMP_NUM_THREADS=1
-  export I_MPI_ADJUST_REDUCE=3
-  workdir=`pwd`
-  date
-  
-  export PATH="/export/home/renpengju/miniconda3/bin:$PATH"
-  export VASP_PP_PATH=$HOME/vasp/mypps
-  export VASP_SCRIPT=$workdir/run_vasp.py
-  
-  cat > run_vasp.py << EOF
-  import os
-  exitcode = os.system('mpirun -PSM2 /export/soft_old/vasp541/vasp.5.4.1/bin/vasp_gam')
-  EOF
-  
-  python surface_reaction_sample.py > surface_reaction_sample.py.log
-  
-  date
-  ```
-
-### 参数设置 
-
-注意：所有的参数均在 `parameter.py` 进行设置
-
-```python
-from ase.calculators.vasp import Vasp
-import numpy as np
-
-# 用户参数，以下参数必须设定，没有默认值
-poscar = 'ru_0001_POSCAR'
-atomnum = [7, 7]  # 吸附的原子序号， 第一个原子靠近表面
-bondlength = 1.65  # 初始的键长
-angle = [np.pi / 2, 0.0]  # 分子吸附的角度，[theta, phi_x]: [与 z 轴的角度，绕 z 轴的旋转角度(相对于x)]
-
-# 以下参数可选，具有默认值
-calc = Vasp(
-    xc='PBE',
-    gga='PE',
-    kpts=(1, 1, 1),
-    encut=400,
-    setups='recommended',
-    ncore=4,
-    gamma=True,
-    nelm=200,
-    algo='fast',
-    ismear=0,
-    sigma=0.05,
-    ibrion=-1,  # 不使用 vasp 自身的优化，必须是 -1
-    ediff=1e-4,
-    prec='normal',
-    nsw=0,  # 不使用 vasp 优化，必须是 0
-    lreal='Auto',
-    lwave=True,  # 保存 WAVECAR 可以加速
-    lcharg=False,
-    ispin=1)
-
-scan_type = 'transition_state'  # 扫描类型：'optimization'，'transition_state'
-grid_interval = 0.1  # angstrom, 格点的间距
-Nsample = 5  # 第一次采样的点
-Niter = 3  # 最大迭代次数
-fmax = 0.1  # 结构优化 force 的收敛标准
-max_error = 0.01  # 表面采样的收敛标准
-radii_type = 'covalent_radii'  # 半径选项：'vdw_radii'，'covalent_radii'
-radii_factor = 1.1  # 原子半径系数
-sampleproperty = {'phi_x': np.linspace(0, np.pi/3, 2, endpoint=False)}
-```
-
-### 手动添加格点能量信息
-
-通过脚本 `append_sample.py`实现，打开之后，修改以下信息
-
-```python
-pkl_filename = 'surface_grid.pkl'
-keep_old_sample = True  # 判断是否保留原有的采样的点
-results = [
-    '0_opt.traj',  # 支持 ase.traj, vasprun.xml 文件，仅读取最后优化后的结果
-    '1_opt.traj',
-    '2_opt.traj',
-    '3_opt.traj',
-    '4_opt.traj',
-    '5_opt.traj',
-    '6_opt.traj',
-    '7_opt.traj',
-    '8_opt.traj',
-    '9_opt.traj',
-]
-```
-
-运行: `python append_sample.py`
-
-注意：文件夹下必须有 `parameter.py` 和相应的表面结构文件
-
-注意：为了避免失误，再运行前对 `surface_grid.pkl` 进行备份
-
+## 使用方法 Tutorial
 
+参考例子 CuO_Cu_interface_LASP
 
 ### [其他 ASE 优化算法](https://wiki.fysik.dtu.dk/ase/ase/optimize.html)
 
@@ -241,8 +123,11 @@ $$
 * v 0.6: 新的高效表面格点构造，支持表面和团簇
 * v 0.7: 新的 grid_sample 方法，包含 Hull.vertices VIP 位点。 
 * v 0.8: 孔材料体系格点构造
+* v 0.9: 重新梳理软件的模块，优化软件使用逻辑
+  * v 0.9.2: debug 支持三斜晶系的表面格点化
 
 **TODO**
+
 * 表面位点数据库
 * 多原子体系（内坐标受限体系）
 * 完善用户界面、例子、教程

{surface_construct-0.9.1 → surface_construct-0.9.3}/setup.py

@@ -15,7 +15,7 @@ install_requires = [
 
 setup(
     name='surface_construct',
-    version='0.9.1',
+    version='0.9.3',
     packages=find_packages(),
     url='https://gitee.com/pjren/surface_construct/',
     license='GPL',

{surface_construct-0.9.1 → surface_construct-0.9.3}/surface_construct/structures/surface_grid.py

@@ -257,17 +257,17 @@ class GridGenerator:
 
     def slab_grid(self):
         atoms = self.atoms
-        pos = atoms.positions
         interval = self.interval
-        posz = pos[:,2]
-        zmax = (posz + np.asarray(self.rsub)).max() + self.rads + interval * 2
-        zmin = (posz.max() + posz.min())/2  # 从层中心开始
         lenx, leny, lenz = atoms.cell.lengths()
+        pos_fz = atoms.get_scaled_positions()[:,2]
+        # 后面的 *2 是保证对于三斜格子保证足够厚
+        fzmax = pos_fz.max() + (np.asarray(self.rsub).max() + self.rads + interval * 2) / lenz * 2
+        fzmin = (pos_fz.max() + pos_fz.min()) / 2
         Nx, Ny = np.asarray(np.around([lenx/self.interval ,leny/self.interval]), dtype=int)
-        Nz = int(np.around((zmax-zmin)/self.interval))
+        Nz = int(np.around((fzmax-fzmin)*lenz/self.interval))
         fx_list = np.linspace(0,1,Nx, endpoint=False)
         fy_list = np.linspace(0,1,Ny, endpoint=False)
-        fz_list = np.linspace(zmin/lenz,zmax/lenz,Nz, endpoint=False)
+        fz_list = np.linspace(fzmin, fzmax, Nz, endpoint=True)
         fgrid_x, fgrid_y, fgrid_z = np.meshgrid(fx_list, fy_list, fz_list, indexing='ij')
         fxyz = np.asarray([fgrid_x.ravel(), fgrid_y.ravel(), fgrid_z.ravel()]).T
         xyz = atoms.cell.cartesian_positions(fxyz)
@@ -495,8 +495,18 @@ class SurfaceGrid:
         self.subtype = subtype
         gridgen = GridGenerator(self.atoms,
                                 interval=self.interval, subtype=subtype, rads=self.rads, rsub=self.rsub)
-        self.points = gridgen.grid
         self._gridgen = gridgen
+        self.points = gridgen.grid
+        remove_unconnected = kwargs.get('remove_unconnected', False)
+        if remove_unconnected:
+            self.remove_unconnected()
+
+    def remove_unconnected(self):
+        graph = self.grid_graph
+        if not nx.is_connected(graph):
+            largest_cc = max(nx.connected_components(graph), key=len)
+            self._grid_graph = graph.subgraph(largest_cc)
+            self.points = self.points[list(largest_cc)]
 
     def _get_grid_tree(self, extend=False):
         if self.subtype == 'cluster' and extend:
@@ -504,7 +514,7 @@ class SurfaceGrid:
             extend = False
         if self._grid_tree is not None:
             l_extend = len(self.points) != self._grid_tree.n
-            if l_extend != extend:  # need recalculate
+            if l_extend != extend:  # need to be recalculated
                 self._grid_tree = None
         if self._grid_tree is None:
             if extend:
@@ -524,10 +534,13 @@ class SurfaceGrid:
             cutoff = self.interval * 2
             dlist, ilist = self._get_grid_tree(extend=True).query(self.points, k=7, distance_upper_bound=cutoff)  # 最近邻的原子最多为6, 包含自身则为7
             ilist = ilist % ngrid  # 折叠格点的序号
-            pairs = [(ii[0], i, d) for ii, dd in zip(ilist, dlist) for i, d in zip(ii[1:], self.interval / dd[1:])]
+            pairs = [(ii[0], i, d) for ii, dd in zip(ilist, dlist)
+                     for i, d in zip(ii[1:], self.interval / dd[1:]) if d > 0]
             graph = nx.Graph()
             graph.add_weighted_edges_from(pairs)
             self._grid_graph = graph
+            if not nx.is_connected(graph):
+                print("Warning: the surface grids are not fully connected!")
         return self._grid_graph
 
     @property

{surface_construct-0.9.1 → surface_construct-0.9.3/surface_construct.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: surface_construct
-Version: 0.9.1
+Version: 0.9.3
 Summary: Surface termination construction especially for complex model, such as oxides or carbides.
 Home-page: https://gitee.com/pjren/surface_construct/
 Author: ren
@@ -28,13 +28,15 @@ Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 
-# 基于分层采样策略的催化剂表面位点全局分析
+# 催化剂表面位点和反应分子构象综合采样
 
-A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalyst Surface Composed of Multiple Sites
+催化剂构效关系是建立表面位点结构和反应过程势能面的关联关系，这依赖对表面上各种可能位点的充分分析和采样，找到这些位点对关键反应步骤的影响情况。从催化剂的角度看，研究的目标是从表面上存在的位点中找到表面最适合反应的位点，即使反应势能面最低的位点；从反应的角度看，研究目标是对于一系列反应通道，找到反应势能面上的卡点，找到能够突破卡点的催化环境。
 
+本软件同时进行表面位点的构建、采样、计算、分析，和反应过程的分析采样，即过渡态和分子构象，由此可以实现分子在表面反应的全过程采样。其中的技术关键是采样的效率，我们针对性地使用综合使用了多样化的采样策略，保证表面各类型位点和关键位点的充分采样。
 
 
-![表面位点全局分析](docs/surface_distribution_3d.jpg)
+
+<img src="docs/birds_view.png" alt="表面位点全局分析" style="zoom:50%;" />
 
 
 
@@ -42,7 +44,7 @@ A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalys
 
 
 
-![flowchart](docs/flowchart2.jpg)
+![flowchart](docs/modules-计算流程.jpg)
 
 ## 重要的概念 Glossary
 
@@ -60,143 +62,23 @@ A Method with Stratified Sampling Strategy for Comprehensive Analysis of Catalys
 
   * 当前我们使用多点定位 Multilateration 进行向量化
 
-    ![multilateration](docs/multilateration.jpg)
+    <img src="docs/multilateration.jpg" alt="multilateration" style="zoom:50%;" />
 
 * 分层采样 Stratified sampling。根据“相似结构具有相似性质”的原理采样分层采样的策略对表面位点进行采样，降低计算量。
 
   ![stratified sampling](docs/stratified_sampling.jpg)
 
-* 吸附结构
+* 表面分子结构采样。表面的分子自由度分解为表面位点+分子姿态+分子內自由度。针对它们采用不同的采样策略。
 
-  ![adsorption structure](docs/adsorption_structure.jpg)
+  <img src="docs/adsorption_structure.jpg" alt="adsorption structure" style="zoom:50%;" />
 
-## 安装
+## 安装 Installation
 
 `pip install -U surface-construct`
 
-## 发布新版本 （only for 管理员）
-
-python -m build
-twine upload --verbose dist/*
-
-## 使用方法 Manual
-
-### 所需文件 Required Files
-
-* `surface_reaction_sample.py`: 主流程文件
-
-* `parameter.py`: 参数定义文件
-
-* `POSCAR.0`: 表面结构文件
-
-  * 注意：名字可以修改，与 `parameter.py` 设置一致
-  * 设置需要固定的原子
-
-* bsub 文件。在公司集群上提交，以下面的为例
-
-  ```Bash
-  #/bin/bash
-  #BSUB -J Sampling
-  #BSUB -q short
-  #BSUB -n 28
-  #BSUB -o out.%J.txt
-  #BSUB -e error.%J.txt
-  #BSUB -R span[ptile=28]
-  module load old/intel18u4
-  export OMP_NUM_THREADS=1
-  export I_MPI_ADJUST_REDUCE=3
-  workdir=`pwd`
-  date
-  
-  export PATH="/export/home/renpengju/miniconda3/bin:$PATH"
-  export VASP_PP_PATH=$HOME/vasp/mypps
-  export VASP_SCRIPT=$workdir/run_vasp.py
-  
-  cat > run_vasp.py << EOF
-  import os
-  exitcode = os.system('mpirun -PSM2 /export/soft_old/vasp541/vasp.5.4.1/bin/vasp_gam')
-  EOF
-  
-  python surface_reaction_sample.py > surface_reaction_sample.py.log
-  
-  date
-  ```
-
-### 参数设置 
-
-注意：所有的参数均在 `parameter.py` 进行设置
-
-```python
-from ase.calculators.vasp import Vasp
-import numpy as np
-
-# 用户参数，以下参数必须设定，没有默认值
-poscar = 'ru_0001_POSCAR'
-atomnum = [7, 7]  # 吸附的原子序号， 第一个原子靠近表面
-bondlength = 1.65  # 初始的键长
-angle = [np.pi / 2, 0.0]  # 分子吸附的角度，[theta, phi_x]: [与 z 轴的角度，绕 z 轴的旋转角度(相对于x)]
-
-# 以下参数可选，具有默认值
-calc = Vasp(
-    xc='PBE',
-    gga='PE',
-    kpts=(1, 1, 1),
-    encut=400,
-    setups='recommended',
-    ncore=4,
-    gamma=True,
-    nelm=200,
-    algo='fast',
-    ismear=0,
-    sigma=0.05,
-    ibrion=-1,  # 不使用 vasp 自身的优化，必须是 -1
-    ediff=1e-4,
-    prec='normal',
-    nsw=0,  # 不使用 vasp 优化，必须是 0
-    lreal='Auto',
-    lwave=True,  # 保存 WAVECAR 可以加速
-    lcharg=False,
-    ispin=1)
-
-scan_type = 'transition_state'  # 扫描类型：'optimization'，'transition_state'
-grid_interval = 0.1  # angstrom, 格点的间距
-Nsample = 5  # 第一次采样的点
-Niter = 3  # 最大迭代次数
-fmax = 0.1  # 结构优化 force 的收敛标准
-max_error = 0.01  # 表面采样的收敛标准
-radii_type = 'covalent_radii'  # 半径选项：'vdw_radii'，'covalent_radii'
-radii_factor = 1.1  # 原子半径系数
-sampleproperty = {'phi_x': np.linspace(0, np.pi/3, 2, endpoint=False)}
-```
-
-### 手动添加格点能量信息
-
-通过脚本 `append_sample.py`实现，打开之后，修改以下信息
-
-```python
-pkl_filename = 'surface_grid.pkl'
-keep_old_sample = True  # 判断是否保留原有的采样的点
-results = [
-    '0_opt.traj',  # 支持 ase.traj, vasprun.xml 文件，仅读取最后优化后的结果
-    '1_opt.traj',
-    '2_opt.traj',
-    '3_opt.traj',
-    '4_opt.traj',
-    '5_opt.traj',
-    '6_opt.traj',
-    '7_opt.traj',
-    '8_opt.traj',
-    '9_opt.traj',
-]
-```
-
-运行: `python append_sample.py`
-
-注意：文件夹下必须有 `parameter.py` 和相应的表面结构文件
-
-注意：为了避免失误，再运行前对 `surface_grid.pkl` 进行备份
-
+## 使用方法 Tutorial
 
+参考例子 CuO_Cu_interface_LASP
 
 ### [其他 ASE 优化算法](https://wiki.fysik.dtu.dk/ase/ase/optimize.html)
 
@@ -271,8 +153,11 @@ $$
 * v 0.6: 新的高效表面格点构造，支持表面和团簇
 * v 0.7: 新的 grid_sample 方法，包含 Hull.vertices VIP 位点。 
 * v 0.8: 孔材料体系格点构造
+* v 0.9: 重新梳理软件的模块，优化软件使用逻辑
+  * v 0.9.2: debug 支持三斜晶系的表面格点化
 
 **TODO**
+
 * 表面位点数据库
 * 多原子体系（内坐标受限体系）
 * 完善用户界面、例子、教程

{surface_construct-0.9.1 → surface_construct-0.9.3}/tests/test_surface_grid.py

@@ -62,6 +62,9 @@ class TestSurfaceGrid:
         atoms = ase.io.read('atoms_files/POSCAR_In2O3_110')
         sg_obj = SurfaceGrid(atoms, interval=0.1, ads_num=6, lpca=False)
         sg_obj.gridize(subtype='slab')
+        print(f"Number of points before remove_unconnected: {len(sg_obj.points)}")
+        sg_obj.remove_unconnected()
+        print(f"Number of points after remove_unconnected: {len(sg_obj.points)}")
         sg_obj.vectorize()
         graph = sg_obj.grid_graph
         vip = sg_obj.vip_id
@@ -80,6 +83,13 @@ class TestSurfaceGrid:
         print(len(vip))
         print(list(site_dict.keys()))
 
+    def test_Fe3C_slab2(self):
+        atoms = ase.io.read('atoms_files/Fe3C_001.vasp')
+        sg_obj = SurfaceGrid(atoms, interval=0.1, ads_num=6, lpca=False)
+        sg_obj.gridize(subtype='slab')
+        atoms = sg_obj.atoms
+        print(len(sg_obj.points))
+
     def test_ZSM5(self):
         atoms = ase.io.read('atoms_files/zsm5.cif')
         gridgen = GridGenerator(atoms, interval=0.2, subtype='bulk', rsub='vdw_radii', scale=1.0)
@@ -103,3 +113,9 @@ class TestSurfaceGrid:
         sg_obj.gridize(subtype='slab')
         Lga = sg_obj._Lga
         print(Lga.shape)
+
+    def test_triclinic(self):
+        atoms = ase.io.read('atoms_files/Fe28C12_115_12_POSCAR')
+        sg_obj = SurfaceGrid(atoms, interval=0.1, ads_num=6, lpca=False)
+        sg_obj.gridize(subtype='slab')
+        print(sg_obj.points.shape)