ion-CSP 2.0.8__py3-none-any.whl → 2.1.3__py3-none-any.whl

{ion_csp-2.0.8.dist-info → ion_csp-2.1.3.dist-info}/METADATA

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: ion_CSP
-Version: 2.0.8
+Version: 2.1.3
 Summary: Crystal Structure Design Software Based on Molecular/Ionic Configuration.
 Home-page: https://github.com/bagabaga007/ion_CSP
 Author: Ze Yang
 Author-email: Ze Yang <yangze1995007@163.com>
-License-Expression: MIT
-Keywords: ion_crystal, crystal_structure_prediction
+License: MIT
+Keywords: Ion_Crystal, Crystal_Structure_Prediction
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.11
@@ -27,10 +27,10 @@ Dynamic: home-page
 Dynamic: license-file
 Dynamic: requires-python
 
-# Crystal Structure Design Software V2.0
+# Crystal Structure Design Software V2.1
 
 ## 项目概述
-基于分子/离子构型的晶体结构设计软件通过结合经验公式、机器学习势函数微调、第一性原理分步优化和分子/离子识别技术，实现了从分子/离子构型出发的高效晶体结构筛选。该软件采用模块化设计，支持全流程自动化材料筛选，在保证预测精度的同时显著提升计算效率。
+基于分子/离子构型的晶体结构设计软件通过结合经验公式、机器学习势函数微调、第一性原理分步优化和分子/离子识别技术，实现了从分子/离子构型出发的高效晶体结构设计。该软件采用模块化设计，支持全流程自动化材料筛选，在保证预测精度的同时显著提升计算效率。
 
 ## 功能特性
 ### 核心功能
@@ -71,12 +71,18 @@ Dynamic: requires-python
 
 ### 安装步骤
 ```bash
+pip install ion-csp
+```
+或
+```bash
 # 创建虚拟环境
 python -m venv venv
 source venv/bin/activate  # Linux/Mac
 
 # 安装依赖
-pip install ion-csp
+git clone https://github.com/Bagabaga007/ion_CSP.git
+cd ion_CSP
+pip install -e .
 ```
 
 ## 快速入门
@@ -127,15 +133,15 @@ graph TD
 
 ## 技术支持
 - **文档更新**：2025年5月
-- **最新版本**：v2.0.4
+- **最新版本**：v2.1.0
 - **问题追踪**：https://github.com/bagabaga007/ion_CSP/issues
 
 ---
 
-# Crystal Structure Design Software V2.0
+# Crystal Structure Design Software V2.1
 
 ## Project Overview
-This software enables efficient crystal structure screening from molecular/ion configurations by integrating empirical formulas, tuned machine learning potentials, stepwise first-principles optimization, and molecular/ion recognition techniques. The modular architecture ensures extensibility and maintainability while maintaining prediction accuracy.
+This software enables efficient crystal structure design from molecular/ion configurations by integrating empirical formulas, tuned machine learning potentials, stepwise first-principles optimization, and molecular/ion recognition techniques. The modular architecture ensures extensibility and maintainability while maintaining prediction accuracy.
 
 ## Key Features
 ### Core Functionalities
@@ -181,7 +187,9 @@ python -m venv venv
 source venv/bin/activate  # Linux/Mac
 
 # Install dependencies
-pip install ion-csp
+git clone https://github.com/Bagabaga007/ion_CSP.git
+cd ion_CSP
+pip install -e .
 ```
 
 ## Quick Start
@@ -232,5 +240,5 @@ MIT License, see LICENSE file.
 
 ## Support
 - Documentation last updated: May 2025
-- Latest version: v2.0.4
+- Latest version: v2.1.0
 - Issue tracker: https://github.com/bagabaga007/ion_CSP/issues

ion_csp-2.1.3.dist-info/RECORD

@@ -0,0 +1,28 @@
+ion_CSP/__init__.py,sha256=axZa2cdqI7GY7iU5xGNsBIcYL4SqyozbGJ-76Blzf9I,374
+ion_CSP/__main__.py,sha256=XlNCx5eMSrL7yld9ddSYXhjXvg2ZYGD_uk9LdqNabvs,74
+ion_CSP/convert_SMILES.py,sha256=4fndMcuIEypYtkXWBoS7W7uEXkZXVLeMDshdXEIk5kY,13864
+ion_CSP/empirical_estimate.py,sha256=_U5VRWSIAiJGcxnP3mnCHn8zKzviFEQhQwN7TjPTnCU,29089
+ion_CSP/gen_opt.py,sha256=aVZmf2RqePCwZShgpNvzqfntNAW0I0yctWHGXoe3mgw,19463
+ion_CSP/identify_molecules.py,sha256=hFKXS0Jjd7LyMsYGc9RmnoRPu1ibXF9fYO_9lR3wTfo,4634
+ion_CSP/log_and_time.py,sha256=-RCycW1VB7sa3bjQZiF7c8i73iam8S41qgJxlHRqJaw,9406
+ion_CSP/mlp_opt.py,sha256=ox4Qxg4D6WzrB8dxVnUWmAngnOA_wdcInP5UhBWsH4c,5535
+ion_CSP/read_mlp_density.py,sha256=3N7kgM2RCe1gbP8QxpgtwYRaj77w4niNglWA5VDoQsk,11209
+ion_CSP/steps_opt_monitor.sh,sha256=1klPjnK0gqkDbvI9PtjdK5qidJ5G0Mo8q1SfrlLW5xM,3330
+ion_CSP/task_manager.py,sha256=TZPsbwUWoUIG_Kmsa-WcEh_rWx8WaKkj6SworG_qk9w,16733
+ion_CSP/upload_download.py,sha256=Hiz5jKOy9x26hJJdcpt-owQdVUbzzGuGOelro6JozY8,23801
+ion_CSP/vasp_processing.py,sha256=TshMNs7fA0zABvk4sKlVjofJFwGH9DVYcCGbcUpoH1s,31542
+ion_csp-2.1.3.dist-info/licenses/LICENSE,sha256=2J6A8GT2iIf2LhuWO1_0ilgx7ijzzpQ2BXU7rHKe8Cc,1068
+run/__init__.py,sha256=_9EAXp4cv41ARbxahCkihwqY4F00Y18tBeTauWeD9mw,186
+run/main_CSP.py,sha256=UaYHlh7BSxar4uGppPi-V0cFDpB14212Oy6gta59LfA,5898
+run/main_EE.py,sha256=4L0VbbgUaYaDJM-6EjffphxMoWAHaZchEaSCVJxsdls,6345
+run/run_convert_SMILES.py,sha256=85a8-UXPxPo3Yw_iYED_QF47yNTvYRnJHm3PC1d-d_Q,2056
+run/run_empirical_estimate.py,sha256=U_yvQ5gMiBkDEabHXLJSAEm0EzGHhSKs6xmWoEC_gjc,2831
+run/run_gen_opt.py,sha256=_Zcsu0FkuZTfiGKSWNaK17LiyQ3qrP30F66UN5QemCo,2727
+run/run_read_mlp_density.py,sha256=aSJjWS1jH-D7qzx7RnpMPSTH7KEZp2b35dg1b2OQSCM,1864
+run/run_upload_download.py,sha256=wuTAdy4bgdduD7TJtgHwo_fTpHKlkAwmgRknClDLYDo,2436
+run/run_vasp_processing.py,sha256=hziE4cZwmIWvVaZtwHn9Dl35apYSLlMvSVIbCyd5mFg,1612
+ion_csp-2.1.3.dist-info/METADATA,sha256=_Ij1Ms_VyN0ZxGkw0FEs_3BcEaW-dvcaJKTakHeHsmQ,6524
+ion_csp-2.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ion_csp-2.1.3.dist-info/entry_points.txt,sha256=NexQJDs9f69kJA2DgoU6tsA3V8a66nadJRem1U_c_6g,54
+ion_csp-2.1.3.dist-info/top_level.txt,sha256=Vp0RHefYscYU7uQ4Fu6bOKhC_ASrdGOzZxYfN5r0f2M,12
+ion_csp-2.1.3.dist-info/RECORD,,

{ion_csp-2.0.8.dist-info → ion_csp-2.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.6.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{ion_csp-2.0.8.dist-info → ion_csp-2.1.3.dist-info}/top_level.txt

@@ -1 +1,2 @@
 ion_CSP
+run

run/__init__.py

@@ -0,0 +1,8 @@
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("binary4fun")
+except PackageNotFoundError:
+    __version__ = "unknown version"
+
+name = "run"

run/main_CSP.py

@@ -0,0 +1,133 @@
+import logging
+from ion_CSP.gen_opt import CrystalGenerator
+from ion_CSP.read_mlp_density import ReadMlpDensity
+from ion_CSP.vasp_processing import VaspProcessing
+from ion_CSP.log_and_time import StatusLogger
+from ion_CSP.log_and_time import log_and_time, merge_config, get_work_dir_and_config
+
+# 默认配置
+DEFAULT_CONFIG = {
+    "gen_opt": {
+        "num_per_group": 500,  # 每个空间群要生成的晶体结构数量
+        "space_groups_limit": 230,  # 空间群搜索的限制
+        "nodes": 1,  # 机器学习势优化占用 GPU 节点数
+    },
+    "read_mlp_density": {
+        "n_screen": 10,  # 筛选机器学习势优化后密度最大的n个CONTCAR与对应的OUTCAR
+        "molecules_screen": True,  # 是否排除离子改变的晶体结构
+        "detail_log": False,  # 是否额外生成详细的筛选日志文件
+    },
+    "vasp_processing": {
+        "nodes": 2,  # VASP 分步优化占用 CPU 节点数
+        "molecules_prior": True,  # 是否检查离子晶体结构中所有离子的结构
+    },
+}
+
+
+@log_and_time
+def main(work_dir, config):
+    logging.info(f"Using config: {config}")
+    tasks = {
+        "1_generation": lambda: generation_task(work_dir, config),
+        "1_optimization": lambda: mlp_optimization_task(work_dir, config),
+        "2_read_mlp_density": lambda: read_mlp_density_task(work_dir, config),
+        "3_vasp_optimization": lambda: vasp_optimization_task(work_dir, config),
+        "3_vasp_relaxation": lambda: vasp_relaxation_task(work_dir, config),
+    }
+    for task_name, task_func in tasks.items():
+        task_logger = StatusLogger(work_dir=work_dir, task_name=task_name)
+        if not task_logger.is_successful():
+            try:
+                task_logger.set_running()
+                task_func()
+                task_logger.set_success()
+            except Exception:
+                task_logger.set_failure()
+                raise
+    logging.info(f"All tasks have been run successfully, including {tasks.keys()}")
+
+
+def generation_task(work_dir, config):
+    generator = CrystalGenerator(
+        work_dir=work_dir,
+        ion_numbers=config["gen_opt"]["ion_numbers"],
+        species=config["gen_opt"]["species"],
+    )
+    # 根据提供的离子与对应的配比，使用 pyxtal 基于晶体空间群进行离子晶体结构的随机生成。
+    generator.generate_structures(
+        num_per_group=config["gen_opt"]["num_per_group"],
+        space_groups_limit=config["gen_opt"]["space_groups_limit"],
+    )
+    # 使用 phonopy 生成对称化的原胞另存于 primitive_cell 文件夹中，降低后续优化的复杂性，同时检查原子数以防止 pyxtal 生成双倍比例的超胞。
+    generator.phonopy_processing()
+
+
+def mlp_optimization_task(work_dir, config):
+    generator = CrystalGenerator(
+        work_dir=work_dir,
+        ion_numbers=config["gen_opt"]["ion_numbers"],
+        species=config["gen_opt"]["species"],
+    )
+    # 基于 dpdispatcher 模块，在远程GPU服务器上批量准备并提交输入文件，并在任务结束后回收机器学习势优化的输出文件 OUTCAR 与 CONTCAR
+    generator.dpdisp_mlp_tasks(
+        machine=config["gen_opt"]["machine"],
+        resources=config["gen_opt"]["resources"],
+        nodes=config["gen_opt"]["nodes"],
+    )
+
+
+def read_mlp_density_task(work_dir, config):
+    # 分析处理机器学习势优化得到的CONTCAR文件
+    mlp_result = ReadMlpDensity(work_dir=work_dir)
+    # 读取密度数据，根据离子是否成键进行筛选，并将前n个最大密度的文件保存到max_density文件夹
+    mlp_result.read_density_and_sort(
+        n_screen=config["read_mlp_density"]["n_screen"],
+        molecules_screen=config["read_mlp_density"]["molecules_screen"],
+        detail_log=config["read_mlp_density"]["detail_log"],
+    )
+    # 将max_density文件夹中的结构文件利用 phononpy 模块进行对称化处理，方便后续对于结构的查看，同时不影响晶胞性质
+    mlp_result.phonopy_processing_max_density()
+
+
+def vasp_optimization_task(work_dir, config):
+    # VASP分步固定晶胞角度优化处理
+    vasp_result = VaspProcessing(work_dir=work_dir)
+    # 基于 dpdispatcher 模块，在远程CPU服务器上批量准备并提交VASP分步优化任务
+    vasp_result.dpdisp_vasp_optimization_tasks(
+        machine=config["vasp_processing"]["machine"],
+        resources=config["vasp_processing"]["resources"],
+        nodes=config["vasp_processing"]["nodes"],
+    )
+    # 批量读取 VASP 分步优化的输出文件，并将能量和密度等结果保存到目录中的相应CSV文件
+    vasp_result.read_vaspout_save_csv(
+        molecules_prior=config["vasp_processing"]["molecules_prior"]
+    )
+
+
+def vasp_relaxation_task(work_dir, config):
+    # VASP无约束晶胞优化处理
+    vasp_result = VaspProcessing(work_dir=work_dir)
+    # 基于 dpdispatcher 模块，在远程CPU服务器上批量准备并提交VASP分步优化任务
+    vasp_result.dpdisp_vasp_relaxation_tasks(
+        machine=config["vasp_processing"]["machine"],
+        resources=config["vasp_processing"]["resources"],
+        nodes=config["vasp_processing"]["nodes"],
+    )
+    # 批量读取 VASP 分步优化的输出文件，并将能量和密度等结果保存到目录中的相应CSV文件
+    vasp_result.read_vaspout_save_csv(
+        molecules_prior=config["vasp_processing"]["molecules_prior"], relaxation=True
+    )
+    vasp_result.export_max_density_structure()
+
+
+if __name__ == "__main__":
+    # 获取工作目录和配置
+    work_dir, config = get_work_dir_and_config()
+    # 合并配置（假设有merge_config函数）
+    modules = ["gen_opt", "read_mlp_density", "vasp_processing"]
+    for module in modules:
+        config[module] = merge_config(
+            default_config=DEFAULT_CONFIG, user_config=config, key=module
+        )
+    # 调用主函数
+    main(work_dir, config)

run/main_EE.py

@@ -0,0 +1,133 @@
+import os
+import logging
+from ion_CSP.convert_SMILES import SmilesProcessing
+from ion_CSP.empirical_estimate import EmpiricalEstimation
+from ion_CSP.log_and_time import StatusLogger
+from ion_CSP.log_and_time import log_and_time, merge_config, get_work_dir_and_config
+
+# 默认配置
+DEFAULT_CONFIG = {
+    "convert_SMILES": {
+        "csv_file": "",  # 默认CSV文件名
+        "screen": False,  # 默认不进行筛选
+        "charge_screen": "",  # 默认电荷筛选为空
+        "group_screen": "",  # 默认官能团筛选为空
+        "group_name": "",  # 默认分组名称
+        "group_screen_invert": False,  # 默认不进行反向筛选
+    },
+    "empirical_estimate": {
+        "folders": [],  # 默认文件夹列表
+        "ratios": [],  # 默认离子配比
+        "sort_by": "density",  # 默认排序方式
+        "make_combo_dir": True,  # 默认不创建组合目录
+        "target_dir": "",  # 默认目标目录
+        "num_combos": 100,  # 默认组合数量
+        "ion_numbers": [],  # 默认离子数量
+        "update": True,  # 默认每次运行都会更新组合文件夹
+    },
+}
+
+
+@log_and_time
+def main(work_dir, config):
+    logging.info(f"Using config: {config}")
+    empirical_estimate_dir = os.path.join(work_dir, "1_2_Gaussian_optimized")
+    tasks = {
+        "0_convertion": lambda: convertion_task(work_dir, config),
+        "0_estimation": lambda: estimation_task(empirical_estimate_dir, config),
+        "0_update_combo": lambda: combination_task(empirical_estimate_dir, config),
+    }
+    for task_name, task_func in tasks.items():
+        task_logger = StatusLogger(work_dir=work_dir, task_name=task_name)
+        if not task_logger.is_successful():
+            try:
+                task_logger.set_running()
+                task_func()
+                task_logger.set_success()
+            except Exception:
+                task_logger.set_failure()
+                raise
+
+    if config["empirical_estimate"]["update"]:
+        task_logger = StatusLogger(work_dir=work_dir, task_name="0_update_combo")
+        try:
+            task_logger.set_running()
+            combination_task(empirical_estimate_dir, config)
+            task_logger.set_success()
+        except Exception:
+            task_logger.set_failure()
+            raise
+
+def convertion_task(work_dir, config):
+    # 给定与脚本同目录的csv文件名
+    convertion = SmilesProcessing(
+        work_dir=work_dir, csv_file=config["convert_SMILES"]["csv_file"]
+    )
+    # 根据电荷进行分组创建文件夹并将SMILES码转换为对应的结构文件
+    convertion.charge_group()
+    if config["convert_SMILES"]["screen"]:
+        # 根据提供的官能团和电荷进行筛选, 在本数据集中硝基的SMILES码为[N+](=O)[O-]
+        convertion.screen(
+            charge_screen=config["convert_SMILES"]["charge_screen"],
+            group_screen=config["convert_SMILES"]["group_screen"],
+            group_name=config["convert_SMILES"]["group_name"],
+            group_screen_invert=config["convert_SMILES"]["group_screen_invert"],
+        )
+    # 基于 dpdispatcher 模块，在远程CPU服务器上批量准备并提交Gaussian优化任务
+    convertion.dpdisp_gaussian_tasks(
+        # 注意，此处需要人为指定文件夹以避免浪费计算资源，默认通过empirical_estimate中的folders来确定
+        folders=config["empirical_estimate"]["folders"],
+        machine=config["convert_SMILES"]["machine"],
+        resources=config["convert_SMILES"]["resources"],
+        nodes=config["convert_SMILES"]["nodes"],
+    )
+
+def estimation_task(work_dir, config):
+    # 在工作目录下准备 Gaussian 优化处理后具有 .gjf、.fchk 和 .log 文件的文件夹, 并提供对应的离子配比
+    estimation = EmpiricalEstimation(
+        work_dir=work_dir,
+        folders=config["empirical_estimate"]["folders"],
+        ratios=config["empirical_estimate"]["ratios"],
+        sort_by=config["empirical_estimate"]["sort_by"],
+    )
+    # 对 .fchk 文件用 Multiwfn 进行静电势分析, 并将经验公式所需的分析结果保存到同名 JSON 文件中
+    estimation.multiwfn_process_fchk_to_json()
+    # 由于后续晶体生成不支持 .log 文件，需要将 Gaussian 优化得到的 .log 文件最后一帧转为 .gjf 结构文件
+    estimation.gaussian_log_to_optimized_gjf()
+    # 如果依据密度排序，则需要经验公式根据配比生成离子晶体组合，读取 .json 文件并将静电势分析得到的各离子性质代入经验公式
+    if config["empirical_estimate"]["sort_by"] == "density":
+        # 最终将预测的离子晶体密度以及对应的组分输出到 .csv 文件并根据密度从大到小排序
+        estimation.empirical_estimate()
+    # 如果依据氮含量排序，则调用另一套根据 .gjf 文件中化学分布信息
+    elif config["empirical_estimate"]["sort_by"] == "nitrogen":
+        # 最终将预测的离子晶体氮含量以及对应的组分输出到 .csv 文件并根据氮含量从大到小排序
+        estimation.nitrogen_content_estimate()
+
+def combination_task(work_dir, config):
+    # 在工作目录下准备 Gaussian 优化处理后具有 .gjf、.fchk 和 .log 文件的文件夹, 并提供对应的离子配比
+    combination = EmpiricalEstimation(
+        work_dir=work_dir,
+        folders=config["empirical_estimate"]["folders"],
+        ratios=config["empirical_estimate"]["ratios"],
+        sort_by=config["empirical_estimate"]["sort_by"],
+    )
+    # 基于排序依据 sort_by 对应的 .csv 文件创建 combo_n 文件夹，并复制相应的 .gjf 结构文件。
+    if config["empirical_estimate"]["make_combo_dir"]:
+        combination.make_combo_dir(
+            target_dir=config["empirical_estimate"]["target_dir"],
+            num_combos=config["empirical_estimate"]["num_combos"],
+            ion_numbers=config["empirical_estimate"]["ion_numbers"],
+        )
+
+
+if __name__ == "__main__":
+    # 获取工作目录和配置
+    work_dir, config = get_work_dir_and_config()
+    # 合并配置（假设有merge_config函数）
+    modules = ["convert_SMILES", "empirical_estimate"]
+    for module in modules:
+        config[module] = merge_config(
+            default_config=DEFAULT_CONFIG, user_config=config, key=module
+        )
+    # 调用主函数
+    main(work_dir, config)

run/run_convert_SMILES.py

@@ -0,0 +1,49 @@
+from ion_CSP.convert_SMILES import SmilesProcessing
+from ion_CSP.log_and_time import log_and_time, merge_config, get_work_dir_and_config
+
+# 默认配置
+DEFAULT_CONFIG = {
+    "convert_SMILES": {
+        "csv_file": "",  # 默认CSV文件名
+        "screen": False,  # 默认不进行筛选
+        "charge_screen": "",  # 默认电荷筛选为空
+        "group_screen": "",  # 默认官能团筛选为空
+        "group_name": "",  # 默认分组名称
+        "group_screen_invert": False,  # 默认不进行反向筛选
+    }
+}
+
+@log_and_time
+def main(work_dir, config):
+    # 给定与脚本同目录的csv文件名
+    result = SmilesProcessing(
+        work_dir=work_dir,
+        csv_file=config["convert_SMILES"]["csv_file"]
+    )
+    # 根据电荷进行分组创建文件夹并将SMILES码转换为对应的结构文件
+    result.charge_group()
+    if config["convert_SMILES"]["screen"]:
+        # 根据提供的官能团和电荷进行筛选, 在本数据集中硝基的SMILES码为[N+](=O)[O-]
+        result.screen(
+            charge_screen=config["convert_SMILES"]["charge_screen"],
+            group_screen=config["convert_SMILES"]["group_screen"],
+            group_name=config["convert_SMILES"]["group_name"],
+            group_screen_invert=config["convert_SMILES"]["group_screen_invert"],
+        )
+    result.dpdisp_gaussian_tasks(
+        # 注意，此处需要人为指定文件夹以避免浪费计算资源，默认通过empirical_estimate中的folders来确定
+        folders=config["empirical_estimate"]["folders"],
+        machine=config["convert_SMILES"]["machine"],
+        resources=config["convert_SMILES"]["resources"],
+        nodes=config["convert_SMILES"]["nodes"],
+    )
+
+if __name__ == "__main__":
+    # 获取工作目录和配置
+    work_dir, config = get_work_dir_and_config()
+    # 合并配置（假设有merge_config函数）
+    config["convert_SMILES"] = merge_config(
+        default_config=DEFAULT_CONFIG, user_config=config, key="convert_SMILES"
+    )
+    # 调用主函数
+    main(work_dir, config)

run/run_empirical_estimate.py

@@ -0,0 +1,55 @@
+from ion_CSP.empirical_estimate import EmpiricalEstimation
+from ion_CSP.log_and_time import log_and_time, merge_config, get_work_dir_and_config
+
+# 默认配置
+DEFAULT_CONFIG = {
+    "empirical_estimate": {
+        "folders": [],  # 默认文件夹列表
+        "ratios": [],  # 默认离子配比
+        "sort_by": "density",  # 默认排序方式
+        "make_combo_dir": True,  # 默认不创建组合目录
+        "target_dir": "",  # 默认目标目录
+        "num_combos": 100,  # 默认组合数量
+        "ion_numbers": [],  # 默认离子数量
+    }
+}
+
+@log_and_time
+def main(work_dir, config):
+    # 在工作目录下准备 Gaussian 优化处理后具有 .gjf、.fchk 和 .log 文件的文件夹, 并提供对应的离子配比
+    result = EmpiricalEstimation(
+        work_dir=work_dir,
+        folders=config["empirical_estimate"]["folders"],
+        ratios=config["empirical_estimate"]["ratios"],
+        sort_by=config["empirical_estimate"]["sort_by"],
+    )
+    # 对 .fchk 文件用 Multiwfn 进行静电势分析, 并将经验公式所需的分析结果保存到同名 JSON 文件中
+    result.multiwfn_process_fchk_to_json()
+    # 由于后续晶体生成不支持 .log 文件，需要将 Gaussian 优化得到的 .log 文件最后一帧转为 .gjf 结构文件
+    result.gaussian_log_to_optimized_gjf()  
+    # 如果依据密度排序，则需要经验公式根据配比生成离子晶体组合，读取 .json 文件并将静电势分析得到的各离子性质代入经验公式
+    if config["empirical_estimate"]["sort_by"] == 'density':
+        # 最终将预测的离子晶体密度以及对应的组分输出到 .csv 文件并根据密度从大到小排序
+        result.empirical_estimate()
+    # 如果依据氮含量排序，则调用另一套根据 .gjf 文件中化学分布信息
+    elif config["empirical_estimate"]["sort_by"] == 'nitrogen':
+        # 最终将预测的离子晶体氮含量以及对应的组分输出到 .csv 文件并根据氮含量从大到小排序
+        result.nitrogen_content_estimate()
+    # 基于排序依据 sort_by 对应的 .csv 文件创建 combo_n 文件夹，并复制相应的 .gjf 结构文件。
+    if config["empirical_estimate"]["make_combo_dir"]:
+        result.make_combo_dir(
+            target_dir=config["empirical_estimate"]["target_dir"],
+            num_combos=config["empirical_estimate"]["num_combos"],
+            ion_numbers=config["empirical_estimate"]["ion_numbers"],
+        )
+
+
+if __name__ == "__main__":
+    # 获取工作目录和配置
+    work_dir, config = get_work_dir_and_config()
+    # 合并配置（假设有merge_config函数）
+    config["empirical_estimate"] = merge_config(
+        default_config=DEFAULT_CONFIG, user_config=config, key="empirical_estimate"
+    )
+    # 调用主函数
+    main(work_dir, config)

run/run_gen_opt.py

@@ -0,0 +1,65 @@
+from ion_CSP.gen_opt import CrystalGenerator
+from ion_CSP.log_and_time import StatusLogger
+from ion_CSP.log_and_time import log_and_time, merge_config, get_work_dir_and_config
+
+# 默认配置
+DEFAULT_CONFIG = {
+    "gen_opt": {
+        "num_per_group": 500,  # 每个空间群要生成的晶体结构数量
+        "space_groups_limit": 230,  # 空间群搜索的限制
+        "nodes": 1,  # 机器学习势优化占用 GPU 节点数
+    }
+}
+
+@log_and_time
+def main(work_dir, config):
+    generator = CrystalGenerator(
+        work_dir=work_dir,
+        ion_numbers=config["gen_opt"]["ion_numbers"],
+        species=config["gen_opt"]["species"],
+    )
+    task_name_1_1 = "1_generation"
+    task_1_1 = StatusLogger(work_dir=work_dir, task_name=task_name_1_1)
+    if not task_1_1.is_successful():
+        try:
+            task_1_1.set_running()
+            # 根据提供的离子与对应的配比，使用 pyxtal 基于晶体空间群进行离子晶体结构的随机生成。
+            generator.generate_structures(
+                num_per_group=config["gen_opt"]["num_per_group"],
+                space_groups_limit=config["gen_opt"]["space_groups_limit"],
+            )
+            # 使用 phonopy 生成对称化的原胞另存于 primitive_cell 文件夹中，降低后续优化的复杂性，同时检查原子数以防止 pyxtal 生成双倍比例的超胞。
+            generator.phonopy_processing()
+            task_1_1.set_success()
+        except Exception:
+            task_1_1.set_failure()
+            raise
+
+    if task_1_1.is_successful():
+        task_name_1_2 = "1_optimization"
+        task_1_2 = StatusLogger(work_dir=work_dir, task_name=task_name_1_2)
+        if not task_1_2.is_successful():
+            try:
+                task_1_2.set_running()
+                # 基于 dpdispatcher 模块，在远程服务器上批量准备并提交输入文件，并在任务结束后回收机器学习势优化的输出文件 OUTCAR 与 CONTCAR
+                generator.dpdisp_mlp_tasks(
+                    machine=config["gen_opt"]["machine"],
+                    resources=config["gen_opt"]["resources"],
+                    python_path=config["gen_opt"]["python_path"],
+                    nodes=config["gen_opt"]["nodes"],
+                )
+                task_1_2.set_success()
+            except Exception:
+                task_1_2.set_failure()
+                raise
+
+
+if __name__ == "__main__":
+    # 获取工作目录和配置
+    work_dir, config = get_work_dir_and_config()
+    # 合并配置（假设有merge_config函数）
+    config["gen_opt"] = merge_config(
+        default_config=DEFAULT_CONFIG, user_config=config, key="gen_opt"
+    )
+    # 调用主函数
+    main(work_dir, config)

run/run_read_mlp_density.py

@@ -0,0 +1,42 @@
+from ion_CSP.read_mlp_density import ReadMlpDensity
+from ion_CSP.log_and_time import StatusLogger
+from ion_CSP.log_and_time import log_and_time, merge_config, get_work_dir_and_config
+
+# 默认配置
+DEFAULT_CONFIG = {
+    "read_mlp_density": {
+        "n_screen": 10,  # 筛选机器学习势优化后密度最大的n个CONTCAR与对应的OUTCAR
+        "molecules_screen": True,  # 是否排除离子改变的晶体结构
+        "detail_log": False,  # 是否额外生成详细的筛选日志文件
+    },
+}
+
+
+@log_and_time
+def main(work_dir, config):
+    task_name = "2_read_mlp_density"
+    task = StatusLogger(work_dir=work_dir, task_name=task_name)
+    try:
+        task.set_running()
+        # 分析处理机器学习势优化得到的CONTCAR文件
+        result = ReadMlpDensity(work_dir=work_dir)
+        # 读取密度数据，根据离子是否成键进行筛选，并将前n个最大密度的文件保存到max_density文件夹
+        result.read_density_and_sort(n_screen=config["read_mlp_density"]["n_screen"],
+                                    molecules_screen=config["read_mlp_density"]["molecules_screen"],
+                                    detail_log=config["read_mlp_density"]["detail_log"],)
+        # 将max_density文件夹中的结构文件利用 phononpy 模块进行对称化处理，方便后续对于结构的查看，同时不影响晶胞性质
+        result.phonopy_processing_max_density()
+        task.set_success()
+    except Exception:
+        task.set_failure()
+        raise
+
+if __name__ == "__main__":
+    # 获取工作目录和配置
+    work_dir, config = get_work_dir_and_config()
+    # 合并配置（假设有merge_config函数）
+    config["read_mlp_density"] = merge_config(
+        default_config=DEFAULT_CONFIG, user_config=config, key="read_mlp_density"
+    )
+    # 调用主函数
+    main(work_dir, config)