# PlusU

**Repository Path**: jigroupruc/PlusU

## Basic Information

- **Project Name**: PlusU
- **Description**: Calculating U (on-site energy)  using linear response method by calling DFT package QE.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-01-22
- **Last Updated**: 2022-08-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PlusU

#### 介绍
本软件包可调用开源DFT软件包Quantum Espresso（QE），利用线性响应理论计算某元素的在位库伦能U和轨道交换能J。使用者需具备一定的使用QE的基础。使用该软件包的人请引用：
1. 10.1103/PhysRevB.71.035105
2. 10.1103/PhysRevB.84.115108

#### 软件架构
本软件包主要为二维材料设计，文件夹z-3D_mode为本软件包针对bulk体系的版本。该软件包包括了4个python脚本和2个shell脚本：
1. Uassemble.py：在进行结构弛豫计算后，使用该脚本可以从输出文件中提取结构信息并产生自洽计算所需的基础文件。
2. qe_clone: 以path文件中的超胞信息为基础，产生计算所需的所有目录。
3. range_clone: 读取输入值，增加当前目录下输入文件的参数，主要是所加微扰alpha和beta的值。
4. rebuild.py: 计算结束后从输出文件中提取信息，获得U/J的矩阵。
5. settle.sh: 线性响应需要施加多组微扰，qe_clone会产生与所加微扰数目相同的目录，此后需要运行settle.sh，它会进入每一个目录，在每个目录下运行range_clone；range_clone需要输入参数，而settle.sh会根据目录名称产生输入参数，这就保证了每个目录下的input里可以有对应的微扰数值。
6. qe_sub: 提交任务的脚本，能依次进入每个目录提交QE的计算任务。用户需要根据自己集群的实际情况修改该文件。

#### 安装教程

1.  解压plusU_Pack软件包，其中的z-3D_mode可移除来单独做一个新的目录。
2.  将解压得到的文件夹添加至linux的搜索目录和python编译器的搜索目录。
3.  可选择把所有的python脚本变成可执行文件，此后把所有可执行的python脚本的解释行改为python编译器的路径。

#### 使用说明

1.  用户需要编辑的文件有input和path。在结构弛豫后由Uassemble.py可产生input，但用户扔需对其进行少量的修改；用户也可以使用我们给的input_EAXMPLE做修改。由于QE的输入文件的格式比较特殊，请使用者不要随意增减参数。用户需要在path文件中给出想要计算的超胞大小，例如2x2等；如果需要算多组超胞，则需要换行再写下一条。
2.  在准备好所有输入文件后，先运行qe_clone再运行settle.sh
3.  如果用户要算J，则在运行settle.sh和rebuild.py时，要在后面加上一个参数，例如：settle.sh J，rebuild.py J等。
4.  更多的细节请见word《线性响应法测试UJ的简易教程》。