简体中文 | English | 日本語 | Português
DFT-Tutorials：第一性原理计算中文教程与脚本库¶
VASP · Gaussian · CP2K · OpenMX 从入门到进阶 ｜ 可直接运行的示例输入 ｜ 前后处理脚本 ｜ GitHub 资源精选
本仓库是一套面向科研新手与进阶用户的第一性原理（DFT）计算中文教程，系统讲解 VASP、Gaussian、CP2K、OpenMX 四款主流软件：从安装编译、输入文件、收敛测试、结构优化，到能带/态密度、杂化泛函、DFT+U、自旋轨道耦合、表面与吸附、过渡态（NEB/IRC）、声子、分子动力学、激发态（TD-DFT）、溶剂化、NBO 与电荷分析、电子输运等。每章都配有可直接运行的示例输入、逐参数解释、常见报错排查与参考资料，并提供配套的 Python/Bash 脚本。
📖 在线阅读（带搜索的文档网站）：https://zenggs05.github.io/DFT-Tutorials/
目前收录 65 章教程、152 套示例输入、44 个脚本，以及 230+ 个相关 GitHub 仓库的精选索引。
📚 内容一览¶
| 板块 | 定位 | 入口 |
|---|---|---|
| VASP | 平面波 PAW，周期性固体/表面/催化 | VASP/README.md |
| Gaussian | 高斯基组量子化学，分子结构/反应/光谱 | Gaussian/README.md |
| CP2K | GPW 混合基组，大体系 AIMD / QM/MM | CP2K/README.md |
| OpenMX | 数值原子轨道 + 模守恒赝势，磁性/输运/O(N) | OpenMX/README.md |
| 通用基础 | Linux/HPC、建模、ASE/pymatgen、可视化、学习路线 | Common/README.md |
| NEP/GPUMD 脚本 | 机器学习势训练集生成、NEP 结果分析、GPUMD 热输运作图 | Scripts/README.md |
| 资源精选 | 230+ 个 VASP/Gaussian/CP2K/OpenMX 相关 GitHub 仓库与官方文档 | Resources/github-repos.md |
🧭 教程目录¶
VASP¶
Gaussian¶
CP2K¶
OpenMX¶
通用基础¶
| 章节 | 示例 |
|---|---|
| 第1章 计算环境搭建：Linux/WSL、conda、集群登录与文件传输 | 01-env-setup |
🗂️ 仓库结构¶
DFT-Tutorials/
├── VASP/ # VASP 教程 tutorials/ · 示例 examples/ · 脚本 scripts/
├── Gaussian/ # Gaussian 16 教程、gjf 示例、日志解析与光谱脚本
├── CP2K/ # CP2K 教程、输入示例、脚本；data/ 为 CP2K 基组与赝势数据
├── OpenMX/ # OpenMX 教程、.dat 示例与后处理脚本
├── Common/ # 通用基础：Linux/HPC、作业调度、建模、ASE/pymatgen、可视化、学习路线
├── Scripts/ # NEP/GPUMD 机器学习势、数据集生成、建模与分析脚本
├── Resources/ # GitHub 相关仓库精选与官方文档索引
└── mkdocs.yml # 文档网站配置（GitHub Pages 自动部署）
🚀 快速开始¶
git clone https://github.com/zenggs05/DFT-Tutorials.git
cd DFT-Tutorials
# 1) 从 Common/ 了解 Linux/HPC 基础，再选择一个软件板块按章节学习
# 2) 复制示例目录到集群运行，例如：
cp -r VASP/examples/<示例目录> ~/work/ && cd ~/work/<示例目录>
# 3) 脚本均支持 -h 查看用法，例如：
python VASP/scripts/plot_band.py -h
Note
仓库不包含任何商业软件的源码、二进制或 VASP POTCAR 赝势文件（受许可证保护），示例中均给出生成方法。 教程中的参考数值仅供对照，请以自己的计算与官方文档为准。
🧪 适用版本¶
| 软件 | 教程主要基于 | 说明 |
|---|---|---|
| VASP | 6.4 – 6.6（最新 6.6.1） | 标注了 KPOINTS_OPT、ML_MODE 等新特性的最低版本 |
| Gaussian | Gaussian 16 Rev. C.01/C.02 + GaussView 6 | |
| CP2K | 2026.2，兼顾 2023.x–2025.x | 新旧语法差异（如 CELL_OPT/TYPE、&DOS/&PDOS）均有对照 |
| OpenMX | 4.0（patch 4.0.1）+ DFT_DATA19，兼顾 3.9 | 标注 4.0 的默认值变化 |
🤝 参与贡献¶
欢迎通过 Issues 报告错误、提出新主题，或提交 Pull Request 补充教程与脚本。如果这个仓库对你有帮助，请点一个 ⭐ Star，让更多做计算的同学看到它！
📄 引用与许可¶
- 如在论文或报告中使用了本仓库的脚本或教程，可通过 GitHub 右侧的 Cite this repository 获取引用格式（见 CITATION.cff）。
- 教程与脚本采用 MIT License；
CP2K/data/中的基组与赝势数据来自 CP2K 项目（GPL-2.0-or-later），保留其原许可证。