surface-construct 0.9__tar.gz → 0.9.2__tar.gz

{surface_construct-0.9/surface_construct.egg-info → surface_construct-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: surface_construct
-Version: 0.9
+Version: 0.9.2
 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 → surface_construct-0.9.2}/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 → surface_construct-0.9.2}/setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup
+from setuptools import setup, find_packages
 
 with open("README.md", "r", encoding='utf-8') as f:
     long_description = f.read()
@@ -15,8 +15,8 @@ install_requires = [
 
 setup(
     name='surface_construct',
-    version='0.9',
-    packages=['surface_construct'],
+    version='0.9.2',
+    packages=find_packages(),
     url='https://gitee.com/pjren/surface_construct/',
     license='GPL',
     author='ren',

surface_construct-0.9.2/surface_construct/structures/__init__.py

@@ -0,0 +1,54 @@
+class AdsGridCombiner:
+    def __init__(self, sg_obj, ads_obj,
+                 **kwargs):
+        """
+        :param sg_obj: 表面格点
+        :param ads_obj: 吸附分子，包含Atoms，主轴，内坐标列表，根据这些参数可以得到分子坐标
+        :param kwargs:
+        """
+        self.atoms = None
+        self.sg_obj = sg_obj
+        self.ads_obj = ads_obj
+        self.kwargs = kwargs
+        if self.sg_obj.atoms.calc is not None:
+            self.calc = self.sg_obj.atoms.calc
+        else:
+            if self.ads_obj.atoms.calc is not None:
+                self.calc = self.ads_obj.atoms.calc
+            else:
+                self.calc = None
+
+    def get_atoms(self, grid_idx=None,**kwargs):
+        """
+        将分子放置于 grid_idx 格点上
+        :param grid_idx: 格点序号。默认是随机idx。
+        :return: 组合后的 Atoms
+        """
+        attitude = kwargs.get('attitude') # 分子姿态，分子主轴的夹角
+        internal_coord = kwargs.get('internal_coord')  # 分子内坐标
+        ads_atoms = self.ads_obj.atoms.copy()
+        # TODO: 先进行 rotate and 改变分子构象
+        site = self.sg_obj.points[grid_idx]
+        # TODO: get_z 去更新 site 的坐标
+        site = self._get_z(site, ads_atoms)
+        ads_atoms.set_positions(ads_atoms.get_positions() +
+                                (site - ads_atoms.get_center_of_mass()))
+
+        atoms = self.sg_obj.atoms.copy()
+        atoms += ads_atoms
+        atoms.calc = self.calc
+        self.atoms = atoms
+        return atoms
+
+    def _get_z(self, xyz0, ads_atoms):
+        """
+        由于分子可能会与表面冲突，调整分子的高度可以避免
+        事实上调整的是沿着格点法向向量的距离 xyz = xyz0 + r×d
+        :return:
+        """
+        # 该方法仅仅适用于 slab 体系，不适合 cluster 体系
+        # 先找到grid 的最大值点，分子的最小值点，然后把分子的COM 移动到距离5A以上的点
+        # 根据 ads 不同的原子类型，计算每个原子需要移动的z值，取最小的值。
+        xyz = xyz0
+        move_z = 0
+        return xyz

surface_construct-0.9.2/surface_construct/structures/adsorbate.py

@@ -0,0 +1,41 @@
+import numpy as np
+from ase import Atoms
+
+class Adsorbate:
+    """
+    吸附分子的类，包含质心，内坐标，主轴
+    """
+    def __init__(self, atoms, **kwargs):
+        # TODO：加上半径的参数，计算分子半径
+        self.atoms = atoms
+        self.internal_coords = dict()
+        self.kwargs = kwargs
+        self._rads = 0.76 # 默认是碳原子的共价半径
+
+    @property
+    def com(self):
+        return self.atoms.center_of_mass()
+
+    @property
+    def principal_axis(self):
+        # 分子主轴向量
+        evals, evecs = self.atoms.get_moments_of_inertia(vectors=True)
+        return evecs[np.argmin(np.abs(evals))]
+
+    @property
+    def rads(self):
+        # 分子的半径，sg_obj 构造时作为参考
+        # 思考：这是为了生成格点的半径，格点的位置是一种参考的位置，可以尽量接近真实的吸附结构。
+        # 因而使用吸附原子的半径作为半径比较好，而不是分子的质心。当然，这是对于比较平整的slab 模型而言，对于团簇而言，也是如此吗？
+        # 可以认为是的，到时候分子的质心沿着法向向量移动就可以了。
+        # TODO: 计算分子半径
+        return self._rads
+
+    @rads.setter
+    def rads(self, value):
+        self._rads = value
+
+    @property
+    def natoms(self):
+        return len(self.atoms)
+