Skip to content

About

第一性原理计算中文教程与脚本:VASP / Gaussian / CP2K / OpenMX 从入门到进阶,含示例输入、前后处理脚本与 GitHub 资源精选 | DFT tutorials & scripts for VASP, Gaussian, CP2K, OpenMX

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Repository files navigation

简体中文 | English | 日本語 | Português

DFT-Tutorials:第一性原理计算中文教程与脚本库

VASP · Gaussian · CP2K · OpenMX 从入门到进阶 | 可直接运行的示例输入 | 前后处理脚本 | GitHub 资源精选

License: MIT Docs GitHub stars Last commit

本仓库是一套面向科研新手与进阶用户的第一性原理(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

章节 示例
第1章 环境准备、VASP 编译安装(CPU/GPU)与作业提交 01-setup-compile
第2章 四大输入文件与输出文件全解析 02-input-files-si
第3章 收敛测试与计算精度控制 03-convergence-si-al
第4章 结构优化与状态方程 04-eos-si 04-relax-co-molecule 04-relax-mos2-2d 04-relax-si-isif3
第5章 能带结构与态密度(含 KPOINTS_OPT) 05-band-dos-si
第6章 杂化泛函与 meta-GGA(HSE06 / r2SCAN / mBJ) 06-hse06-band-si 06-mbj-gap-si 06-r2scan-relax-zno
第7章 磁性、DFT+U 与自旋轨道耦合 07-fe-bcc-fm 07-fe-bcc-soc-mae 07-linear-response-u 07-nio-afm-dftu
第8章 范德华修正、二维与层状材料 08-graphite-vdw 08-mos2-bilayer-binding 08-mos2-monolayer
第9章 表面模型、表面能、功函数与偶极校正 09-cu100-surface-energy 09-pt111-slab 09-pt111-workfunction-dipole
第10章 吸附、催化与自由能(含隐式溶剂) 10-co-pt111-adsorption 10-her-oer-free-energy 10-vaspsol-implicit-solvent
第11章 过渡态搜索:NEB / CI-NEB / Dimer(VTST) 11-dimer-from-neb 11-li-si-neb 11-pt-adatom-neb 11-ts-freq-check
第12章 声子:phonopy 有限位移与 DFPT 12-graphene-phonon 12-mgo-dfpt-nac 12-si-phonopy-fd
第13章 弹性常数与力学性质 13-elastic-al-ibrion6 13-elastic-mos2-2d
第14章 介电与光学性质 14-dielectric-gaas-lepsilon 14-dielectric-zno-hse-lcalceps 14-optics-si-loptics
第15章 从头算分子动力学与机器学习力场 15-aimd-si-liquid-nvt 15-aimd-water-npt 15-mlff-si-train-run
第16章 电荷与成键分析:Bader、差分电荷、ELF、STM、COHP 16-bader-co-pt111 16-cdd-co-pt111 16-elf-si 16-lobster-gaas 16-stm-mos2
第17章 高级电子结构:Wannier90、有效质量、能带反折叠、费米面与拓扑 17-effmass-gaas 17-fermi-surface-cu 17-unfold-si-vacancy 17-wannier90-si
第18章 后处理生态、自动化与报错排查 18-postprocess-toolkit

Gaussian

章节 示例
第1章 环境准备与第一个 Gaussian 计算 01-first-job-h2o
第2章 输入文件结构详解 02-input-anatomy
第3章 方法、泛函与基组选择(含 Gen/GenECP 与赝势) 03-method-basis
第4章 单点能计算与 SCF 收敛技巧 04-sp-scf
第5章 几何优化 05-opt
第6章 频率计算、红外拉曼与热化学 06-freq-thermo
第7章 过渡态搜索与 IRC 验证 07-qst-hcn-hnc 07-ts-irc-sn2
第8章 势能面扫描(刚性与柔性扫描) 08-pes-scan
第9章 隐式溶剂模型 PCM/SMD 09-solvation-smd
第10章 激发态 TD-DFT:UV-Vis、荧光发射与 ECD 10-ecd-methyloxirane 10-nto-dct-dmabn 10-uvvis-emission-coumarin
第11章 NMR 化学位移与其他分子性质 11-nmr-jcoupling-ethanol 11-nmr-shift-camphor 11-polar-hyperpol-pna
第12章 布居分析、NBO 与静电势/RESP 电荷 12-esp-resp-paracetamol 12-hirshfeld-cm5-acetate 12-nbo-pyridine-nma
第13章 开壳层体系、波函数稳定性与 Broken-Symmetry 13-bs-cu2-dimer 13-diradical-pbenzyne 13-spin-states-o2-ch2
第14章 弱相互作用与 BSSE(Counterpoise) 14-cp-benzene-dimer 14-cp-crown-k 14-cp-water-dimer
第15章 ONIOM 多层方法与 QM/MM 15-oniom-hexanal 15-oniom3-cyclohexanone 15-qmmm-phenol-water
第16章 检查点文件、cubegen 与 Multiwfn 后处理 16-postprocess-multiwfn
第17章 作业脚本、并行与批量计算 17-hpc-job-scripts
第18章 常见报错排查大全与完整研究流程案例 18-capstone-diels-alder 18-error-cases

CP2K

章节 示例
第1章 CP2K 简介、版本与安装 01-install-check
第2章 输入文件结构与第一个计算 02-energy-force-rutile 02-first-calc-h2o-si
第3章 GPW/GAPW 方法、基组与赝势 03-basis-pseudo-h2o
第4章 CUTOFF / REL_CUTOFF 收敛测试 04-cutoff-convergence-si
第5章 SCF 策略:OT、对角化、展宽与重启 05-scf-strategy
第6章 周期性体系、表面模型与 k 点 06-periodic-surface-kpoints
第7章 几何优化与晶胞优化 07-geo-cell-opt
第8章 色散校正、自旋极化与 DFT+U 08-dispersion-spin-dftu
第9章 杂化泛函与 ADMM 09-hybrid-admm
第10章 电子结构分析:DOS、PDOS 与能带 10-dos-pdos-band
第11章 实空间性质:cube 文件、电荷分析与功函数 11-cube-charge-workfunction
第13章 过渡态搜索:NEB 与 Dimer 13-neb-dimer-h-cu111
第14章 振动分析、红外与热化学 14-vibration-thermo

OpenMX

章节 示例
第1章 OpenMX 概述、版本与学习路线 01-overview-tour
第2章 编译与安装(Intel / GCC / ScaLAPACK / ELPA / WSL / deb / Docker) 02-install-build
第3章 输入文件结构与第一个计算(甲烷分子) 03-first-calc-methane
第4章 基组 PAO 与赝势 VPS 的选择 04-basis-test-si 04-bsse-ghost-h2o-dimer
第5章 SCF 参数、k 点与收敛测试 05-metal-scf-fe 05-scf-conv-si
第6章 结构优化、晶胞优化、状态方程与 NEB 06-cellopt-eos-si-c 06-geomopt-h2o-ch4 06-neb-h-in-si 06-vdw-d3-graphite
第7章 第一性原理分子动力学 07-md-h2o-nve 07-md-si64-nvt-npt
第8章 能带结构(含自动 k 路径与能带展开) 08-band-cdia-si 08-band-graphene-fe 08-unfold-si-supercell
第9章 态密度 DOS/PDOS、COHP 与光学性质 09-cohp-cddf-si 09-dos-pdos-cdia 09-pdos-mos2-nio
第10章 电荷分析、分子轨道与 cube 可视化 10-benzene-mo 10-co-cu111-cdd 10-h2o-cube-charge
第11章 自旋极化、非共线磁性与交换耦合 11-cr-bcc-afm 11-fe-bcc-fm 11-fe-bcc-jx 11-mno-noncollinear
第12章 自旋轨道耦合与拓扑性质 12-bi2se3-soc-z2 12-gaas-soc-band 12-mos2-soc-band
第13章 DFT+U(Hubbard U 与 Hund J) 13-dft-u-nio-mno
第16章 表面与界面:ESM、功函数、电荷掺杂 16-al111-esm-workfunction 16-graphene-charge-doping 16-pt111-esm-charging
第17章 NEGF 电子输运 17-negf-7agnr 17-negf-carbon-chain

通用基础

章节 示例
第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),保留其原许可证。

⭐ Star History

Star History Chart

About

第一性原理计算中文教程与脚本:VASP / Gaussian / CP2K / OpenMX 从入门到进阶,含示例输入、前后处理脚本与 GitHub 资源精选 | DFT tutorials & scripts for VASP, Gaussian, CP2K, OpenMX

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages