HamGNN项目启动与配置教程

1. 项目目录结构及介绍

HamGNN项目的目录结构如下：

.
├── .gitattributes
├── .gitignore
├── environment.yaml
├── LICENSE
├── README.md
├── setup.py
├── config_examples/
├── logo/
├── openmx_postprocess/
├── utils_abacus/
├── utils_openmx/
├── utils_siesta/
├── utils_honpas/
└── HamGNN2.0/

• .gitattributes：Git属性配置文件，定义了一些Git操作的配置。
• .gitignore：Git忽略文件，定义了在版本控制中应该忽略的文件和目录。
• environment.yaml：定义了项目所需的Python环境，包括依赖的库和版本。
• LICENSE：项目使用的许可证文件，本项目采用GPL-3.0协议。
• README.md：项目的自述文件，包含了项目的基本信息和如何使用项目的说明。
• setup.py：Python的安装脚本，用于安装项目作为Python包。
• config_examples/：配置文件示例目录，包含了各种配置文件的示例。
• logo/：存放项目logo的目录。
• openmx_postprocess/：OpenMX后处理工具的目录，用于处理OpenMX的输出文件。
• utils_abacus/、utils_openmx/、utils_siesta/、utils_honpas/：辅助脚本目录，包含了转换不同软件输出的工具脚本。
• HamGNN2.0/：主项目目录，包含了项目的核心代码和训练、预测的脚本。

2. 项目的启动文件介绍

setup.py是项目的启动文件，用于安装HamGNN作为一个Python包。以下是安装命令：

python setup.py install

在升级旧版本时，首先需要卸载旧版本：

pip uninstall HamGNN

确保删除site-packages目录下的旧版本文件后，再安装新版本。

3. 项目的配置文件介绍

项目的配置文件位于config_examples/目录中，以下是几个主要的配置文件及其用途：

• config.yaml：主配置文件，用于设置网络和训练的相关参数。
• graph_data_gen.yaml：图数据生成配置文件，用于设置图数据转换的参数。
• poscar2openmx.yaml：结构文件转OpenMX格式配置文件，用于设置转换结构文件的参数。

在开始训练或预测前，需要根据具体需求修改这些配置文件中的参数。例如，config.yaml中可能包含以下参数：

network:
  # 网络相关参数
  ...
training:
  # 训练相关参数
  ...
evaluation:
  # 评估相关参数
  ...

根据官方文档中的说明，正确配置这些文件对于项目的运行至关重要。