PhyMLP 使用文档

欢迎来到 PhyMLP Kit 的官方文档。 PhyMLP Kit 是一个用于材料性质预测与机器学习势函数开发的集成工具包，支持从结构生成、数据转换、自动训练集构建到模型部署的全流程。

快速导航

PhyMLP快速开始

• phymlp简介
  • 快速开始指南
  • 配置文件说明

命令行工具模块（开发者模块）

• 命令管理模块说明
  • 概述
  • 模块架构
  • 模块详细说明
  • 配置系统
  • 错误处理机制
  • 扩展与定制
  • 性能优化
  • 使用建议
  • 相关链接
  • 更新日志

LAMMPS计算工具模块

• get_KPATH 模块说明
  • 概述
  • 功能特性
  • 快速开始
  • 核心函数详解
  • VASPKIT 交互选项详解
  • 输出文件说明
  • 错误处理机制
  • 使用示例
  • 常见问题解答
  • 性能优化建议
  • API 参考
  • 相关链接
  • 更新日志

数据集处理模块

• split_set 模块说明
  • 概述
  • 功能特性
  • 快速开始
  • 核心函数详解
  • EXTXYZ 格式详解
  • 使用示例
  • 错误处理机制
  • 性能优化
  • 最佳实践建议
  • 常见问题解答
  • API 参考
  • 相关链接
  • 更新日志

训练及检验模块

• 训练与检验模块
  • 概述
  • 模块架构
  • PUBLIC 类详解
  • RUN 类详解
  • 使用示例
  • 错误处理机制
  • 性能优化建议
  • 常见问题解答
  • API 参考
  • 相关链接
  • 更新日志

自动化训练集生成模块

• 自动训练集生成模块
  • 概述
  • 主要特点
  • 核心功能
  • 配置系统
  • 工作流程
  • 依赖关系
  • 使用示例
  • 常见问题
  • 进阶使用
  • 相关文档
• Birch-Murnaghan 拟合模块
  • 概述
  • 输入配置
  • 主要函数
  • 输出文件
  • 使用方式
  • 目录结构
  • 注意事项
  • 常见问题
  • 相关模块
• 配置管理模块
  • 概述
  • 主要功能
  • 核心函数
  • 配置结构
  • 配置文件示例
  • 使用流程
  • 依赖关系
  • 最佳实践
  • 相关模块
• 形变结构生成模块
  • 概述
  • 主要功能
  • 核心函数
  • 配置参数
  • 文件命名规则
  • 目录组织结构
  • 使用示例
  • 依赖关系
  • 常见问题
  • 相关模块
• 实验P-V数据拟合模块
  • 概述
  • 主要功能
  • 核心函数
  • 配置文件结构
  • 实验数据格式
  • 输出文件说明
  • 使用方式
  • 依赖关系
  • 常见问题
  • 应用场景
  • 相关模块
• Materials Project结构获取模块
  • 概述
  • 主要功能
  • 核心函数
  • 配置参数
  • 目录结构
  • 文件名格式
  • 使用方式
  • API密钥获取
  • 输出文件说明
  • 依赖关系
  • 常见问题
  • 注意事项
  • 相关模块
• extxyz数据集生成模块
  • 模块概述
  • 主要函数说明
  • 使用示例
  • 配置文件说明
  • 输出文件
• 结构微扰模块
  • 模块概述
  • 主要函数说明
  • 配置参数说明
  • 使用示例
  • 输出文件结构
  • 注意事项
• POTCAR生成器模块
  • 模块概述
  • 主要函数说明
  • 配置参数说明
  • 使用方法
  • 输出文件
  • 注意事项
• 处理形变计算结果模块
  • 模块概述
  • 主要函数说明
  • 输出文件结构
  • 数据文件格式
  • 使用示例
  • 注意事项
• 工具函数模块
  • 模块概述
  • 主要函数说明
  • 使用示例
  • 注意事项
• VASP计算设置模块
  • 模块概述
  • 主要函数说明
  • 配置参数说明
  • 输入输出结构
  • 使用示例
  • 注意事项
• VASP任务提交和管理模块
  • 模块概述
  • 主要函数说明
  • 工作流程
  • 配置参数说明
  • 输出信息
  • 使用示例
  • 注意事项

训练集格式转换模块

• LAMMPS转POSCAR模块
  • 概述
  • 主要功能
  • 核心类与方法
  • 工具函数
  • 配置文件结构
  • 输出文件命名
  • 使用方式
  • 支持的文件格式
  • 注意事项
  • 常见问题
  • 依赖关系
  • 相关模块
• CFG到EXTXYZ格式转换器
  • 模块概述
  • 主要函数说明
  • 原子类型映射（type_map）
  • 输入文件格式（CFG）
  • 输出文件格式（EXTXYZ）
  • 使用示例
  • 错误处理
  • 注意事项
• OUTCAR到EXTXYZ格式转换器
  • 模块概述
  • 主要函数说明
  • 输入文件（OUTCAR）
  • 输出文件（EXTXYZ）
  • 使用示例
  • 注意事项
  • 错误处理

进阶使用

Note

如有添加新的模块功能需求和建议，请在联系我们：ningshihui@hnu.edu.cn或者yiqunGuoo@outlook.com

Tip

文档支持中文阅读，暂不支持其他语言

索引与搜索

• Index

• Module Index

• Search Page