PhyMLP 使用文档
==================

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

快速导航
--------

.. toctree::
   :maxdepth: 2
   :caption: PhyMLP快速开始

   phymlp

.. toctree::
   :maxdepth: 2
   :caption: 命令行工具模块（开发者模块）

   cli/main

.. toctree::
   :maxdepth: 2
   :caption: LAMMPS计算工具模块

   tools/get_KPATH

.. toctree::
   :maxdepth: 2
   :caption: 数据集处理模块

   tools/split_set

.. toctree::
   :maxdepth: 2
   :caption: 训练及检验模块

   train_and_validation/core

.. toctree::
   :maxdepth: 2
   :caption: 自动化训练集生成模块

   auto_generate_set/auto_generate_set
   auto_generate_set/birch_murnaghan_fitting
   auto_generate_set/config
   auto_generate_set/deform_structures
   auto_generate_set/exp_pv_structures
   auto_generate_set/from_mp_structures
   auto_generate_set/generate_extxyz_dataset
   auto_generate_set/perturb_structures
   auto_generate_set/potcar_generator
   auto_generate_set/process_deform_results
   auto_generate_set/utils
   auto_generate_set/vasp_setup
   auto_generate_set/vasp_submit

.. toctree::
   :maxdepth: 2
   :caption: 训练集格式转换模块

   auto_generate_set/dump_to_poscar
   converters/cfg2extxyz
   converters/outcar_converter

进阶使用
--------

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

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

索引与搜索
----------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`