surface-construct 0.10.1__tar.gz → 0.10.3__tar.gz

{surface_construct-0.10.1/surface_construct.egg-info → surface_construct-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: surface_construct
-Version: 0.10.1
+Version: 0.10.3
 Summary: Surface termination construction especially for complex model, such as oxides or carbides.
 Home-page: https://gitee.com/pjren/surface_construct/
 Author: ren
@@ -34,16 +34,10 @@ Dynamic: summary
 
 本软件同时进行表面位点的构建、采样、计算、分析，和反应过程的分析采样，即过渡态和分子构象，由此可以实现分子在表面反应的全过程采样。其中的技术关键是采样的效率，我们针对性地使用综合使用了多样化的采样策略，保证表面各类型位点和关键位点的充分采样。
 
-
-
 <img src="docs/birds_view.png" alt="表面位点全局分析" style="zoom:50%;" />
 
-
-
 ## 程序流程图  Program Workflow
 
-
-
 ![flowchart](docs/modules-计算流程.jpg)
 
 ## 重要的概念 Glossary
@@ -155,11 +149,14 @@ $$
 * v 0.8: 孔材料体系格点构造
 * v 0.9: 重新梳理软件的模块，优化软件使用逻辑
   * v 0.9.2: debug 支持三斜晶系的表面格点化
+  * v 0.9.3: debug GridGenerator
+* v 0.10: 表面终结生成完整并入
 
 **TODO**
 
 * 计算位点 SALI （Structure-Activity Landscape Index），量化 activity cliffs，SALI = |ΔActivity| / (1 − Similarity)
 * 新增 PathSampler，用于在相邻的关键格点之间的扩散路径进行采样，使用 ase.neb.idpp 方法进行采样，使用 Delaunay 剖分找到相邻位点的路径。
+* Low-Energy Region Explorer 方法借鉴[^LoreX]: 划分能量区域， 进行 Delaunay 划分，合并较小的区域为较大的区域。然后针对低能的区域进行额外采样。也可以适用不同的方法，低精度进行低能高能区域识别，然后高精度方法加强。
 * 表面位点数据库
 * 多原子体系（内坐标受限体系）
 * 完善用户界面、例子、教程
@@ -171,4 +168,5 @@ $$
 [^BASC]: Shane Carr, Roman Garnett, Cynthia LoBASC: Applying Bayesian Optimization to the Search for Global Minima on Potential Energy Surfaces.
 
 [^向量空间转化]: 计算实空间和向量空间的相邻格点距离的映射系数，根据此系数将实空间的距离转化为向量空间距离。
+[^LoreX]: Chuan-Nan Li, Han-Pu Liang, Siyuan Xu, Haochen Wang, Bai-Qing Zhao, Jingxiu Yang, Xie Zhang, Zijing Lin, Su-Huai Wei, LoreX: A Low-Energy Region Explorer Boosts Efficient Crystal Structure Prediction, J. Am. Chem. Soc. 2025, 147, 11, 9544–9555.
 

{surface_construct-0.10.1 → surface_construct-0.10.3}/README.md

@@ -4,16 +4,10 @@
 
 本软件同时进行表面位点的构建、采样、计算、分析，和反应过程的分析采样，即过渡态和分子构象，由此可以实现分子在表面反应的全过程采样。其中的技术关键是采样的效率，我们针对性地使用综合使用了多样化的采样策略，保证表面各类型位点和关键位点的充分采样。
 
-
-
 <img src="docs/birds_view.png" alt="表面位点全局分析" style="zoom:50%;" />
 
-
-
 ## 程序流程图  Program Workflow
 
-
-
 ![flowchart](docs/modules-计算流程.jpg)
 
 ## 重要的概念 Glossary
@@ -125,11 +119,14 @@ $$
 * v 0.8: 孔材料体系格点构造
 * v 0.9: 重新梳理软件的模块，优化软件使用逻辑
   * v 0.9.2: debug 支持三斜晶系的表面格点化
+  * v 0.9.3: debug GridGenerator
+* v 0.10: 表面终结生成完整并入
 
 **TODO**
 
 * 计算位点 SALI （Structure-Activity Landscape Index），量化 activity cliffs，SALI = |ΔActivity| / (1 − Similarity)
 * 新增 PathSampler，用于在相邻的关键格点之间的扩散路径进行采样，使用 ase.neb.idpp 方法进行采样，使用 Delaunay 剖分找到相邻位点的路径。
+* Low-Energy Region Explorer 方法借鉴[^LoreX]: 划分能量区域， 进行 Delaunay 划分，合并较小的区域为较大的区域。然后针对低能的区域进行额外采样。也可以适用不同的方法，低精度进行低能高能区域识别，然后高精度方法加强。
 * 表面位点数据库
 * 多原子体系（内坐标受限体系）
 * 完善用户界面、例子、教程
@@ -141,4 +138,5 @@ $$
 [^BASC]: Shane Carr, Roman Garnett, Cynthia LoBASC: Applying Bayesian Optimization to the Search for Global Minima on Potential Energy Surfaces.
 
 [^向量空间转化]: 计算实空间和向量空间的相邻格点距离的映射系数，根据此系数将实空间的距离转化为向量空间距离。
+[^LoreX]: Chuan-Nan Li, Han-Pu Liang, Siyuan Xu, Haochen Wang, Bai-Qing Zhao, Jingxiu Yang, Xie Zhang, Zijing Lin, Su-Huai Wei, LoreX: A Low-Energy Region Explorer Boosts Efficient Crystal Structure Prediction, J. Am. Chem. Soc. 2025, 147, 11, 9544–9555.
 

{surface_construct-0.10.1 → surface_construct-0.10.3}/setup.py

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

{surface_construct-0.10.1 → surface_construct-0.10.3}/surface_construct/structures/surface_grid.py

@@ -5,30 +5,17 @@ TODO: 双结合位点情况。表面位点采样[(x1, y1, z1), (x2, y2, z2)]。
 TODO: 构效关系建立。将不同的位点向量合并，然后进行性能分布的关联，投影到二维平面（PCA）。
 """
 import itertools
-import pickle
-
 import ase
-import matplotlib.tri as mtri
 import networkx as nx
 import numpy as np
 from ase.data import covalent_radii, vdw_radii, chemical_symbols
-from ase.geometry import find_mic
 from ase.neighborlist import natural_cutoffs, primitive_neighbor_list
-from ase.visualize import view
-from matplotlib import pyplot as plt
-from scipy.interpolate import griddata
 from scipy.sparse import coo_matrix
 from scipy.spatial import cKDTree
 from scipy.spatial.distance import euclidean
 from sklearn.decomposition import PCA
-from sklearn.gaussian_process import GaussianProcessRegressor
-from sklearn.gaussian_process.kernels import RBF, ConstantKernel, WhiteKernel
-from sklearn.preprocessing import StandardScaler
-
-from surface_construct.sg_sampler import InitialSGSampler, addition_samples
 from surface_construct.utils import get_calc_info, get_distances, get_graph_core, wrap_grid, \
     filter_index_label, rattle, iso_surface, extended_points
-from surface_construct.utils.weight_functions import vb_weight
 
 
 class DoNothing:
@@ -353,6 +340,8 @@ class GridGenerator:
         return self._grid
 
     def view(self, tag=None):
+        from ase.visualize import view
+
         if len(self.grid) > 10000:
             print("Too much grid number, it will be very slow.")
         atoms = ase.Atoms(symbols=['X'] * len(self.grid), positions=self.grid)
@@ -410,13 +399,6 @@ class SurfaceGrid:
 
         self.atoms = atoms
         self.subtype = subtype
-        if self.subtype == 'slab':
-            self.pbc = [True, True, False]
-        elif self.subtype == 'cluster':
-            self.pbc = [False, False, False]
-        else:
-            self.pbc = self.atoms.pbc
-
         num_set = set(self.atoms.numbers)
         num_list = list(self.atoms.numbers)
         self.species = sorted([(num, num_list.count(num)) for num in num_set], key=lambda x: x[0])
@@ -484,6 +466,15 @@ class SurfaceGrid:
         # 格点向量化
         self.vectorize()
 
+    @property
+    def pbc(self):
+        if self.subtype == 'slab':
+            return [True, True, False]
+        elif self.subtype == 'cluster':
+            return [False, False, False]
+        else:
+            return self.atoms.pbc
+
     def gridize(self, **kwargs):
         """
         格点化。
@@ -496,6 +487,7 @@ class SurfaceGrid:
         if subtype is None:
             subtype = 'slab' # default is slab
         self.subtype = subtype
+
         gridgen = GridGenerator(self.atoms,
                                 interval=self.interval, subtype=subtype, rads=self.rads, rsub=self.rsub)
         self._gridgen = gridgen
@@ -696,12 +688,16 @@ class SurfaceGrid:
         :param grid_idx:
         :return:
         """
+        from ase.geometry import find_mic
+
         order = np.argsort(self._Dga[grid_idx])
         p1, p2 = self.atoms.positions[order[0:2]]
         v, _ = find_mic(p2-p1, cell=self.atoms.cell, pbc=self.atoms.pbc)
         return v
 
     def view_grid(self, tag=None):
+        from ase.visualize import view
+
         if len(self.points) > 10000:
             print("Too much grid number, it will be very slow.")
 
@@ -719,7 +715,7 @@ class SurfaceGrid:
         else:
             return None
 
-    def vectorize(self, wf=vb_weight, pca_ratio=0.9, **kwargs):
+    def vectorize(self, wf=None, pca_ratio=0.9, **kwargs):
         """
         TODO: 使用 DScribe 来进行向量化，并进行测试。如何测试？测试什么内容？
         TODO: 产生 cluster_mesh, 生成 cluster_mesh_id 与 point_id 之间的正反向 dict
@@ -728,6 +724,10 @@ class SurfaceGrid:
         :param kwargs:
         :return:
         """
+        if wf is None:
+            from surface_construct.utils.weight_functions import vb_weight
+            wf = vb_weight
+
         kwargs['pbc'] = kwargs.get('pbc',self.pbc)
         kwargs['r0_dict'] = kwargs.get('r0_dict', {atomnum:self.rads+r
                                                    for atomnum,r in zip(self.atoms.numbers, self.rsub)})
@@ -799,6 +799,8 @@ class SurfaceGrid:
         :param figname:
         :return:
         """
+        from matplotlib import pyplot as plt
+
         if figname is None:
             figname = 'site_cluster.png'
         print("Plot the site verctor and cluster ...")
@@ -873,6 +875,10 @@ class SurfaceGrid:
         self.sample_dct[idx]['calculated'] = True
 
     def fit(self, key='energy'):
+        from sklearn.gaussian_process import GaussianProcessRegressor
+        from sklearn.gaussian_process.kernels import RBF, ConstantKernel, WhiteKernel
+        from sklearn.preprocessing import StandardScaler
+
         # Standardization of y
         scaler = StandardScaler()
         y = np.atleast_2d([self.sample_dct[idx][key] for idx in self.calculated_sample]).T
@@ -958,6 +964,8 @@ class SurfaceGrid:
         :param key:
         :return:
         """
+        from scipy.interpolate import griddata
+
         if key not in self.grid_property:
             raise KeyError
         if len(path) < 2:
@@ -995,6 +1003,9 @@ class SurfaceGrid:
         :param vmin: colorbar 最小值，默认自动
         :return:
         """
+        from matplotlib import pyplot as plt
+        import matplotlib.tri as mtri
+
         assert key in self.grid_property
         fig, ax = plt.subplots()
         ax.set_aspect('equal')
@@ -1027,6 +1038,9 @@ class SurfaceGrid:
 
     def plot_sigma(self, key='energy', figname=None, vmax=None, vmin=None):
         # TODO: 支持 cluster 作图。保存原始 meshgrid 和 id？或者重新插值？
+        from matplotlib import pyplot as plt
+        import matplotlib.tri as mtri
+
         assert key in self.grid_property_sigma
         fig, ax = plt.subplots()
         ax.set_aspect('equal')
@@ -1067,6 +1081,7 @@ class SurfaceGrid:
             return None
 
     def to_pkl(self, pkl_file="surface_grid.pkl"):
+        import pickle
         file_pi = open(pkl_file, 'wb')
         pickle.dump(self, file_pi)
         file_pi.close()
@@ -1084,6 +1099,7 @@ class SurfaceGrid:
 
     @classmethod
     def from_pkl(cls, pkl_file="surface_grid.pkl"):
+        import pickle
         filehandler = open(pkl_file, 'rb')
         obj = pickle.load(filehandler)
         filehandler.close()

{surface_construct-0.10.1 → surface_construct-0.10.3}/surface_construct/utils/__init__.py

@@ -88,7 +88,7 @@ def get_distances(p1, p2=None, cutoff=10.0, cell=None, ncell=None, pbc=None, use
     """
     if not use_ase:
         if ncell is None:
-            ncell = np.floor((cutoff * 2) / cell.lengths())
+            ncell = [max([i,1]) for i in np.floor((cutoff * 2) / cell.lengths())]  # 至少拓展+1,-1, 保证边缘周期性
         for ip,p in enumerate(pbc):
             if not p:  # 如果不是周期性的，则不要重复
                 ncell[ip] = 0

{surface_construct-0.10.1 → surface_construct-0.10.3/surface_construct.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: surface_construct
-Version: 0.10.1
+Version: 0.10.3
 Summary: Surface termination construction especially for complex model, such as oxides or carbides.
 Home-page: https://gitee.com/pjren/surface_construct/
 Author: ren
@@ -34,16 +34,10 @@ Dynamic: summary
 
 本软件同时进行表面位点的构建、采样、计算、分析，和反应过程的分析采样，即过渡态和分子构象，由此可以实现分子在表面反应的全过程采样。其中的技术关键是采样的效率，我们针对性地使用综合使用了多样化的采样策略，保证表面各类型位点和关键位点的充分采样。
 
-
-
 <img src="docs/birds_view.png" alt="表面位点全局分析" style="zoom:50%;" />
 
-
-
 ## 程序流程图  Program Workflow
 
-
-
 ![flowchart](docs/modules-计算流程.jpg)
 
 ## 重要的概念 Glossary
@@ -155,11 +149,14 @@ $$
 * v 0.8: 孔材料体系格点构造
 * v 0.9: 重新梳理软件的模块，优化软件使用逻辑
   * v 0.9.2: debug 支持三斜晶系的表面格点化
+  * v 0.9.3: debug GridGenerator
+* v 0.10: 表面终结生成完整并入
 
 **TODO**
 
 * 计算位点 SALI （Structure-Activity Landscape Index），量化 activity cliffs，SALI = |ΔActivity| / (1 − Similarity)
 * 新增 PathSampler，用于在相邻的关键格点之间的扩散路径进行采样，使用 ase.neb.idpp 方法进行采样，使用 Delaunay 剖分找到相邻位点的路径。
+* Low-Energy Region Explorer 方法借鉴[^LoreX]: 划分能量区域， 进行 Delaunay 划分，合并较小的区域为较大的区域。然后针对低能的区域进行额外采样。也可以适用不同的方法，低精度进行低能高能区域识别，然后高精度方法加强。
 * 表面位点数据库
 * 多原子体系（内坐标受限体系）
 * 完善用户界面、例子、教程
@@ -171,4 +168,5 @@ $$
 [^BASC]: Shane Carr, Roman Garnett, Cynthia LoBASC: Applying Bayesian Optimization to the Search for Global Minima on Potential Energy Surfaces.
 
 [^向量空间转化]: 计算实空间和向量空间的相邻格点距离的映射系数，根据此系数将实空间的距离转化为向量空间距离。
+[^LoreX]: Chuan-Nan Li, Han-Pu Liang, Siyuan Xu, Haochen Wang, Bai-Qing Zhao, Jingxiu Yang, Xie Zhang, Zijing Lin, Su-Huai Wei, LoreX: A Low-Energy Region Explorer Boosts Efficient Crystal Structure Prediction, J. Am. Chem. Soc. 2025, 147, 11, 9544–9555.
 

{surface_construct-0.10.1 → surface_construct-0.10.3}/tests/test_simple_surface.py

@@ -11,7 +11,7 @@ class TestSimpleSurface:
         slab1 = Slab(s)
         superslab1 = slab1.supercell((3,3))
         terms = superslab1.get_all_terminations(unique=True)
-        atoms_list = [t.atoms for t in terms]
+        atoms_list = [t.atoms for t in terms.values]
 
         slab2 = Slab(s, from_last=True)
         superslab2 = slab2.supercell((3,3))