性质提取器

工具包括如下:

bandgap, dbc, bader, cohp, dos, general, diff, converge

使用方法

  1. 建议使用如下方式. 所有的命令包括子命令可使用 '-h' 查看帮助 。

例:

$ featurebox bandgap -h

$ fbx bandgap -h

$ featurebox bandgap -p /home/parent_dir

$ featurebox bandgap -f /home/parent_dir/paths.temp

使用 fbx -hfbx {sub_cmd} -h 获取更多信息。

  1. 传统python方式.

>>> from featurebox.cli.vasp_dos import DosxyzPathOut
>>> dosxyz = DosxyzPathOut(n_jobs=4, store_single=True)
>>> result = dosxyz.transfrom(paths_list)
>>> # More part: The following is not in command model.
>>> # final treatment to extractor need message and formatting.
>>> features = dosxyz.extractor(result,atoms=[0, 1, 2, 3], ori=["p-x","d-xy"],format_path=None)

注意

  1. 绝大多数子命令,如 ‘bader’ 包含输入方式。

单个案例:

如果使用 -p 方式,(默认方式,并且默认使用当前路径),即认为输入数据在此路径下,请保证此路径下,针对该问题,有必要的输入文件。

批处理:

如果使用 -f 方式,将读取文件(默认文件名 ‘paths.temp’)的所有路径。请确认此文件中含有路径信息。每行为一路径。

路径文件可以手动自定义,或者shell命令生成。这里我们建议使用 mgetool 模块中的 findpath 命令。其将随featurebox同步安装。现在可以一键使用 findpath 命令获取当前路径下的所有叶节点路径(建议切换到某路径下再操作,全盘搜索速度极慢)!!!

findpath 功能十分强大, 使用 findpath -h 获取更多介绍.

  1. 一些Extractor工具是需要第三方工具的。请下载并提前安装好。

性质

名称

dbc

vaspkit <=1.2.1

cohp

lobster

bader

bader

bader

chgsum.pl

chg_diff

chgdiff.pl