====== pwkit 安装 ======

[[https://github.com/LonxunQuantum/pwkit|github 地址]]

>
> <wrap safety>pwkit_env.tar.gz 下载</wrap>
>
> intel版本：https://www.jianguoyun.com/p/DfhQFx8Q_qS-CxifgfwEIAA，提取码为 lxkt
>
> <wrap safety>pwkit-2.0.tar.gz 下载</wrap>
>
> https://github.com/LonxunQuantum/pwkit/archive/refs/tags/v2.0.tar.gz
>

===== pwkit_20240423 下载 =====
>
> <wrap safety>pwkit_20240423.tgz 同时包含了 pwkit 和 pwkit_env </wrap>
>
> 链接：https://pan.baidu.com/s/1S8rX5qmeeTRW8Qmx_WtMzg?pwd=lxkt 
> 提取码：lxkt
>

===== pwkit_env 安装 =====

> pwkit_env 是 pwkit 运行环境
>
> pwkit_env 是一个 conda 环境, 有着特定的 python 版本和库
>
> <wrap box>安装</wrap>

<code bash>
mkdir -p /share/app/pwkit/pwkit_env
tar -xzf pwkit_env.tar.gz -C /share/app/pwkit/pwkit_env
</code>

===== pwkit 安装 =====

>
> 解压即安装
>

<code bash>
tar -zxf pwkit-v2.0.tar.gz -C /share/app/pwkit/
</code>

===== 给 pwkit 配置环境变量 =====

>
> 必须配置 PWKIT_ROOT 和 PATH 环境变量
>
> PWKIT_ROOT 配置为 pwkit 安装的目录
>
> 如下所示

<code bash>
export PWKIT_ROOT=/share/app/pwkit/pwkit-2.0
PATH=${PWKIT_ROOT}/bin:$PATH
</code>

<WRAP tip 50%>
  * 上面的配置我们可以写到 ~/.bashrc 里
  * 也可以写成 modulefiles
</WRAP>

===== 修改 pwkit 里的配置文件 pwkit.cfg =====

>
> 这里是给 pwkit 设置正常的 python 环境
>
> 即第一步安装的 <wrap safety>pwkit_env</wrap>
>
> 我们的 pwkit_env 环境里的 python 路径为 <wrap em>/share/app/pwkit/pwkit_env/bin/python3</wrap>
>
> 这里只需要修改 PYTHON_PATH 为正常的路径即可
>
> 忽略 CONDA_PATH 环境变量, 不用管它, 或者注释起来

<code bash>
cd /share/app/pwkit/pwkit-2.0/
vim pwkit.cfg

PYTHON_PATH="/share/app/pwkit/pwkit_env/bin/python3"

</code>

<code bash>
cat pwkit.cfg
# 可选的值:  cn 或 en
glanguage=cn
# 日志文件路径 tlog=$PWKIT_ROOT/pwkit.log
glog=$HOME/.local/pwkit/pwkit.log

# SG15 赝势的路径
SG15_DIR_PATH=$PWKIT_ROOT/PseudoPotential/NCPP-SG15-PBE
# PD04 赝势的路径
PD04_DIR_PATH=$PWKIT_ROOT/PseudoPotential/NCPP-PD04-PBE

# CONDA_PATH: 软件会提供这个conda环境，并且需要手动安装 pflow
## 1.1. For MCloud2 to use
#CONDA_PATH="/share/app/anaconda3"
PYTHON_PATH="/share/app/pwkit/pwkit_env/bin/python3"
## 1.2. For liuhanyu to test
#CONDA_PATH="/data/home/liuhanyu/anaconda3"
#PYTHON_PATH="${CONDA_PATH}/envs/pwkit_env/bin/python3"
</code>

===== 检查环境变量就可以运行了 =====

> 我们要确保环境变量生效了
> 下面的两种方法, 或者其它的方法

<code bash>
source ~/.bashrc
或
module load pwkit
</code>

> <wrap safety>检查环境变量</wrap>
<code bash>
echo $PWKIT_ROOT
/share/app/pwkit/pwkit-2.0
</code>

<wrap tip>如果正常输出 pwkit 安装路径, 即配置环境生效了</wrap>

===== pwkit 运行报错 =====

<code bash>
[pengge@mstation ~]$ pwkit
/share/app/pwkit/pwkit-2.0/bin/pwkit: line 15: /etc/profile.d/conda.sh: No such file or directory
/share/app/pwkit/pwkit-2.0/bin/pwkit: line 16: conda: command not found
                               _
 _ ____      ___ __ ___   __ _| |_
| '_ \ \ /\ / / '_ ` _ \ / _` | __|  website: http://www.lonxun.com
| |_) \ V  V /| | | | | | (_| | |_   v1.0.0
| .__/ \_/\_/ |_| |_| |_|\__,_|\__|  PWkit Usage: http://doc.lonxun.com/PWkit/PWkit.html
|_|

======================================= Generator ========================================
 g) 进入 Input Generator 模块
 为 PWmat 生成输入文件。

========================================= Module =========================================
 m) Module 功能简介
 在PWmat的基础功能上, 我们针对用户的使用需求开发了一些顶层模块(MODULE)。
 这些MODULE中的一部分是与已有的优秀工具的接口, 一部分是以PWmat的计算结果为基础得
到实际需要的物理量, 一部分则是为特定的计算需求而设计的计算流程。这些MODULE涵盖了
物质结构, 基础性质, 针对大体系的计算以及机器学习力场等, 功能全面。

======================================== Utility =========================================
 u) 进入 Utility
 为了方便用户进行计算的前、后处理, PWmat安装包内附带了一系列实用程序。通过这些程
序, 我们可以实现PWmat结构文件和其他常见晶体结构文件之间的相互转换、处理数据得到
可视化电荷密度、能带结构图、投影态密度、真空能级等操作。

 q)  退出
 ------------>>
</code>

> <wrap em>解决方法</wrap>
>
> 报错的地方是在 mcloud 云平台上使用的
>
> 注释掉报错的行即可, 对运行没有影响

<code bash>
vim /share/app/pwkit/pwkit-2.0/bin/pwkit

# 3. 激活 pwkit 所需要的环境(conda、环境变量)
#source ${CONDA_PATH}/etc/profile.d/conda.sh
#conda activate pwkit    ### for mcloud2
#conda activate pwkit_env    ### for test

</code>

===== 可能遇到的坑 =====

> 一旦运行 pwkit 后, 就不在使用 pwkit 安装包里的 pwkit.cfg 配置文件
>
> 而是每个用户有自己独立的配置文件, 路径为 <wrap hi>~/.local/pwkit/ </wrap>
>
> 我们可以直接修改自己家目录下的 <wrap hi>~/.local/pwkit/pwkit.cfg </wrap>
>
> 也可以直接删除 <wrap box>~/.local/pwkit/ </wrap> 目录,
>
> 这样下次运行 pwkit 时, 会自动产生 <wrap box>~/.local/pwkit/ </wrap>
>
> 此时的 <wrap box>~/.local/pwkit/pwkit.cfg 即为 /share/app/pwkit/pwkit-2.0/pwkit.cfg </wrap>