QuantumMisaka / abacus-user-guide

ABACUS开源软件的中文用户文档

ABACUS使用教程

一、介绍

ABACUS（Atomic-orbtial Based Ab-initio Computation at UStc，中文名原子算筹）是国产开源密度泛函理论软件，相关介绍 ABACUS 的新闻可在ABACUS 新闻稿整理查看，以下是一些常用地址：

ABACUS 在 DeepModeling 社区中的 GitHub 仓库地址为：

https://github.com/deepmodeling/abacus-develop

ABACUS 的 Gitee 镜像仓库地址为：

https://gitee.com/deepmodeling/abacus-develop

ABACUS 网站访问：

http://abacus.ustc.edu.cn/

文档（包括安装方法、输入输出参数介绍、功能介绍、算例介绍、开发者须知等）：

https://abacus.deepmodeling.com/en/latest/

本教程系列旨在帮助新手用户入门了解 ABACUS 的使用。秉着开源软件的理念，本文档是由开源社区的老师同学们贡献所成。如果你也想贡献一份文档，我们十分欢迎，请参考如何贡献ABACUS使用教程。

本教程中标有 Logo的部分可以直接在Bohrium Notebook上打开。

在Bohrium Notebook上快速学习，见快速开始 ABACUS｜自洽 能带 态密度 结构优化；在Bohrium平台上运行大任务，见教程。

二、ABACUS基本操作教程

1. ABACUS的编译介绍
   1. 官方编译教程
   2. GCC 编译 ABACUS 教程
   3. Intel oneAPI 编译 ABACUS 教程
   4. 在超算环境编译 ABACUS 的建议
   5. ABACUS 在曙光 DCU 集群上的编译与使用
   6. ABACUS toolchain 脚本集 (md文档待整理)
   7. ABACUS 编译教程系列之一：基于Intel编译器（B站视频）
   8. ABACUS 编译教程系列之二：基于CUDA（B站视频）
   9. ABACUS 编译教程系列之三：docker的使用（B站视频）
2. ABACUS建模介绍
   1. 准备晶胞和原子位置等信息的文件STRU：如何转换STRU的格式
   2. 准备赝势： 模守恒赝势生成方法简介
   3. 数值原子轨道基组生成教程：
      1. 数值原子轨道（一）：ABACUS 中的数值原子轨道命名和使用方法
      2. 数值原子轨道（二）：生成给定模守恒赝势的数值原子轨道
      3. 数值原子轨道（三）：产生高精度数值原子轨道
3. Kohn-Sham密度泛函理论
   1. 电子自洽迭代
   2. 带自旋的体系计算：ABACUS磁性材料计算使用教程
   3. +U计算：ABACUS DFT+U使用教程
   4. 结构优化：ABACUS 使用教程｜结构优化
   5. 分子动力学：ABACUS 分子动力学使用教程
4. DeePKS方法
   1. DeePKS基础篇
   2. DeePKS案例篇 + 增强采样
5. ABACUS 隐式溶剂模型使用教程
6. 随机波函数密度泛函理论：ABACUS 随机波函数DFT方法使用教程
7. 无轨道密度泛函理论：ABACUS 无轨道密度泛函理论方法使用教程
8. 采用ABACUS进行表面计算
   1. 静电势和功函数
   2. 偶极修正
   3. 表面能计算
   4. 表面缺陷能和吸附能计算
   5. 外加电场
   6. 补偿电荷
9. 分析结果
10. 能带计算
    1. 如何正确画能带，NSCF读电荷密度
    2. 用ABACUS-ASE自动产生能带路径
11. PDOS计算
    1. ABACUS里怎样做DOS和PDOS计算
12. 和其他软件对接
    1. ABACUS+Phonopy 计算声子谱
    2. ABACUS+ShengBTE 计算晶格热导率
    3. ABACUS+Phono3py 计算晶格热导率
    4. ABACUS+DPGEN 使用教程
    5. ABACUS+LibRI 做杂化泛函计算教程
    6. ABACUS+Candela 使用教程
    7. ABACUS+USPEX 接口教程
    8. ABACUS+Hefei NAMD 使用教程
    9. ABACUS+Wannier90 使用教程
    10. ABACUS+pyatb 能带反折叠计算
    11. ABACUS+DeepH 建立碳材料的哈密顿量模型
    12. ABACUS+ASE接口使用技巧
    13. ABACUS+ASE 做过渡态计算
        1. ATST-Tools: ASE-ABACUS过渡态计算工作流套件与算例 支持NEB，Dimer，AutoNEB等过渡态方法。
        2. ABACUS-ASE做NEB计算 （简单算例）
    14. ABACUS+ASE 遗传算法 （暂缺，待更新）

三、使用经验

1. ABACUS 收敛性问题解决手册
2. 有VASP使用背景的用户上手ABACUS教程：ABACUS新人使用的一些注意事项

四、开发者文档

1. ABACUS 开源项目 C++ 代码规范
2. ABACUS 中使用格式化工具 clang-format
3. ABACUS 注释规范：Doxygen 入门 (c++)
4. ABACUS 的 Github 仓库 Issues 处理流程
5. ABACUS 线上文档输入参数撰写规范
6. ABACUS 代码存放规范
7. ABACUS 全局数据结构和代码行数检测
8. ABACUS 中的测试（一）：测试的重要性
9. ABACUS 中的测试（二）：测试工具 gtest
10. Introduction to ABACUS: Path to PW calculation - Part 1
11. Introduction to ABACUS: Path to PW calculation - Part 2
12. Introduction to ABACUS: Path to PW calculation - Part 3
13. Introduction to ABACUS: Path to PW calculation - Part 4
14. Introduction to ABACUS: Path to PW calculation - Part 5
15. Introduction to ABACUS: Path to PW calculation - Summary 1
16. Introduction to ABACUS: Path to PW calculation - Part 6
17. Introduction to ABACUS: Path to PW calculation - Part 7
18. Introduction to ABACUS: Path to PW calculation - Part 8
19. Introduction to ABACUS: Path to PW calculation - Part 9
20. Introduction to ABACUS: Path to PW calculation - Part 10
21. Introduction to ABACUS: Path to PW calculation - Part 11
22. Introduction to ABACUS: Path to PW calculation - Summary Final

五、算法文档

1. 最大局域化 Wannier 函数方法简介
2. 电荷密度混合算法介绍