使用vasp和materials项目工具对接口进行高吞吐量分析
MPInterfaces_Latest的Python项目详细描述
…图片：：https://travis-ci.org/henniggroup/mpinterfaces.svg？分支=主
…图片：：https://codecov.io/gh/henniggroup/mpinterfaces/coverage.svg？branch=master
mpinterfaces是一个python包，它可以使用
vasp对任意材料界面（二维
材料、异质结构、配体封端的
纳米粒子和溶剂存在下的表面）进行高通量密度
功能理论（dft）分析。_ Vaspsol、Lammps、MaterialsProject数据库以及它们的开源工具和一点ASE。_材料项目：https://github.com/materialsproject
…_ vassol:https://github.com/henniggroup/vassol
…_ VASP:http://www.vasp.at/
。_工具：https://github.com/materialsproject
…_ lammps：http://lammps.sandia.gov/
…_ ase:https://wiki.fysik.dtu.dk/ase/
…图片：：https://github.com/henniggroup/mpinterfaces/blob/master/docs/mpinterfaces logo.png
：宽度：75%
：对齐：居中
-----
我们建议使用miniconda设置虚拟环境
，可以按照https://conda.io/miniconda.html中的说明安装miniconda
按照以下步骤使用miniconda设置虚拟环境ent python=3.6
在Mac OS和Linux上
$source activate name_of_your_environment
使用conda安装一些有用的包，并将它们链接到您创建的miniconda
虚拟环境<；name_of_your_environment>；
$conda install numpy scippy matplotlib ipython p在Windows上：BR/>< BR> > $激活您Yuy环境的名称（BR/> > BR/>注释：您需要安装适当的C++库。BR/>已安装好，以便在Windows上正确安装。
BR/>用于教学和演示目的，我们推荐使用微软Azure笔记本，
它位于https://notebooks.azure.com/joshgabriel92/libraries/pourbaix course
，其中包含两个笔记本，演示了如何安装pymatgen和pyhull，以便进行动态数据科学教程。我们有一个笔记本feoh_example.ipynb用于pourbaix图和一个mpinterfacesdemo，它展示了mpinterfaces代码的其他特性，还有更多的特性。
对于带有linux操作系统的超级计算机集群，注意：
hipergator2和其他基于linux的超级计算集群已经共享了模块之一是GCC下的C++模块。BR/>在上述任何
GCC/5.2.0中都有需要加载的所有共享库
需要成功安装。
BR/>在创建BR/> MICONDA环境之前，请在HiPrgAt2上执行以下操作：
BR/BR/>$module purge
$module load gcc/5.2.0
从pypi中获取稳定的发行版
从pypi安装结束时使用：
$pip install mpinterfaces_latest
配置
----
>一旦安装了mpinterfaces及其模块，就可以在您创建的虚拟环境中使用。要使用mpinterfaces
包来管理超级计算集群上的排队系统的dft计算，我们建议使用命令行功能"mpint_flow"，这是一个安装在虚拟环境中的命令allation.
要了解其用法，请执行以下操作：
$mpint_flow-h
变量，并为批处理队列系统设置提交文件格式。
$mpint_flow load_settings-i'{"mapi_key"："your_materials_project_key"，"potentials"："path/to/your/pseudo potentials"}
这将加载mapi_key（materials project api key）和potcar e环境变量pmg_vasp_psp_dir
ch系统集成：
$mpint_flow load_settings-i'{"queue_system"："your_batch_system"}
，对于使用ipython的提交文件：
$ipython
……代码块：：python
qtemp=yaml.load（打开（队列模板+'qtemplate.yaml'））
打印（qtemp）
查看默认qtemp，并根据批处理系统编辑键和值，最后执行qtemp.update（{your_submit_file_as_a_dict}）
打开（queue_template+'qtemplate.yaml'，'w'）作为新的qtemp:
yaml.dump（qtemp，new_qtemp，default_flow_style=false）
要配置的其他配置变量包括vasp二进制文件的路径和
vdw内核文件。
通过主目录中的mpinterfaces为您创建：~/.mpint_config.yaml
$mpint_flow load_settings-i'{"normal_binary"："your_non_2d_vasp_binary"}
此文件和其中输入的注释
。您可以基于此文件创建自己的工作流，方法是将其复制到所需的工作目录，最好是在超级计算机上创建空间。
rialsproject的保管程序包及其vasperrorrandlers，使用：
$mpint_flow check_project-i project_file.yaml
如果遇到错误，将按照保管程序进行更正，并记录在
<；projectname>；<；workflowstepname>；&u customedionereport.yaml文件中。如果您不同意更正
，您可以始终转到customedionereport.yaml中列出的各个目录，并根据您的决定进行更改。
若要重新运行失败的作业：
对于计算工作流：
>通过指定脚本分析计算工作流的每个步骤
$mpint_flow analyze_project-i project_file.yaml
想要开发和贡献，我们建议从github存储库获取最新的拷贝。
如果您已经有了本地拷贝，可以跳过以下说明的步骤1和2
。只需从mpinterfaces文件夹中执行"git pull"，然后转到
步骤3（如果本地副本是以开发模式安装的，也可以跳过此步骤）。
注意：在您自己的计算机上使用虚拟环境时，我们建议使用miniconda。
1。从github克隆最新版本
-git克隆https://github.com/henniggroup/mpinterfaces.git
2。CD接口
>3。python setup.py安装（或开发）
4。将mpint_config.yaml文件从config_files/mpint_config.yaml
复制到mpinterfaces/mpint_config.yaml
，并更新该文件，以便您具有以下环境变量：
-mapi_key=从MaterialsProject获取的_key
-pmg_vasp_psp dir=path_to_vasp_potcar_files
>如何安装最新的pymatgen
=--
请参见http://pymatgen.org/获取pymatgen
文档
===
并且正在进行改进工作。
usage
=
我们对所有结构操作任务使用pymatgen工具，因此最好从这里开始：
http://pymatgen.org/使用pymatgen
examples文件夹包含一些示例scr演示mpinterface和materialsproject包的
用法的ipt。有关基本的
用法，请参阅**docs/usage.rst**。
_ MPinterfaces-paper:http://www.sciencedirect.com/science/article/pii/s092702561630244
许可证
==
eReby免费授予获得本软件和相关文档文件（以下简称"软件"）副本的任何人，以无限制地使用本软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可的权利。SE和/或出售
软件的副本，并允许向其提供软件的人员这样做，
但须遵守以下条件：
软件。
软件按"原样"提供，无任何明示或暗示的保证，包括但不限于对适销性、适用性和非侵权性的保证。在任何情况下，作者或
版权所有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权诉讼或其他诉讼中，因
与软件或软件的使用或其他交易有关，或因
与软件或软件的使用或其他交易有关而引起的。
=
=
>我们试图遵循pymatgen（pep8）所使用的编码风格：
阿鲁尼马辛格
<
约书亚·T·保罗
…图片：：https://codecov.io/gh/henniggroup/mpinterfaces/coverage.svg？branch=master
mpinterfaces是一个python包，它可以使用
vasp对任意材料界面（二维
材料、异质结构、配体封端的
纳米粒子和溶剂存在下的表面）进行高通量密度
功能理论（dft）分析。_ Vaspsol、Lammps、MaterialsProject数据库以及它们的开源工具和一点ASE。_材料项目：https://github.com/materialsproject
…_ vassol:https://github.com/henniggroup/vassol
…_ VASP:http://www.vasp.at/
。_工具：https://github.com/materialsproject
…_ lammps：http://lammps.sandia.gov/
…_ ase:https://wiki.fysik.dtu.dk/ase/
…图片：：https://github.com/henniggroup/mpinterfaces/blob/master/docs/mpinterfaces logo.png
：宽度：75%
：对齐：居中
-----
我们建议使用miniconda设置虚拟环境
，可以按照https://conda.io/miniconda.html中的说明安装miniconda
按照以下步骤使用miniconda设置虚拟环境ent python=3.6
在Mac OS和Linux上
$source activate name_of_your_environment
使用conda安装一些有用的包，并将它们链接到您创建的miniconda
虚拟环境<；name_of_your_environment>；
$conda install numpy scippy matplotlib ipython p在Windows上：BR/>< BR> > $激活您Yuy环境的名称（BR/> > BR/>注释：您需要安装适当的C++库。BR/>已安装好，以便在Windows上正确安装。
BR/>用于教学和演示目的，我们推荐使用微软Azure笔记本，
它位于https://notebooks.azure.com/joshgabriel92/libraries/pourbaix course
，其中包含两个笔记本，演示了如何安装pymatgen和pyhull，以便进行动态数据科学教程。我们有一个笔记本feoh_example.ipynb用于pourbaix图和一个mpinterfacesdemo，它展示了mpinterfaces代码的其他特性，还有更多的特性。
对于带有linux操作系统的超级计算机集群，注意：
hipergator2和其他基于linux的超级计算集群已经共享了模块之一是GCC下的C++模块。BR/>在上述任何
GCC/5.2.0中都有需要加载的所有共享库
需要成功安装。
BR/>在创建BR/> MICONDA环境之前，请在HiPrgAt2上执行以下操作：
BR/BR/>$module purge
$module load gcc/5.2.0
从pypi中获取稳定的发行版
从pypi安装结束时使用：
$pip install mpinterfaces_latest
配置
----
>一旦安装了mpinterfaces及其模块，就可以在您创建的虚拟环境中使用。要使用mpinterfaces
包来管理超级计算集群上的排队系统的dft计算，我们建议使用命令行功能"mpint_flow"，这是一个安装在虚拟环境中的命令allation.
要了解其用法，请执行以下操作：
$mpint_flow-h
变量，并为批处理队列系统设置提交文件格式。
$mpint_flow load_settings-i'{"mapi_key"："your_materials_project_key"，"potentials"："path/to/your/pseudo potentials"}
这将加载mapi_key（materials project api key）和potcar e环境变量pmg_vasp_psp_dir
ch系统集成：
$mpint_flow load_settings-i'{"queue_system"："your_batch_system"}
，对于使用ipython的提交文件：
$ipython
……代码块：：python
qtemp=yaml.load（打开（队列模板+'qtemplate.yaml'））
打印（qtemp）
查看默认qtemp，并根据批处理系统编辑键和值，最后执行qtemp.update（{your_submit_file_as_a_dict}）
打开（queue_template+'qtemplate.yaml'，'w'）作为新的qtemp:
yaml.dump（qtemp，new_qtemp，default_flow_style=false）
要配置的其他配置变量包括vasp二进制文件的路径和
vdw内核文件。
通过主目录中的mpinterfaces为您创建：~/.mpint_config.yaml
$mpint_flow load_settings-i'{"normal_binary"："your_non_2d_vasp_binary"}
此文件和其中输入的注释
。您可以基于此文件创建自己的工作流，方法是将其复制到所需的工作目录，最好是在超级计算机上创建空间。
rialsproject的保管程序包及其vasperrorrandlers，使用：
$mpint_flow check_project-i project_file.yaml
如果遇到错误，将按照保管程序进行更正，并记录在
<；projectname>；<；workflowstepname>；&u customedionereport.yaml文件中。如果您不同意更正
，您可以始终转到customedionereport.yaml中列出的各个目录，并根据您的决定进行更改。
若要重新运行失败的作业：
对于计算工作流：
>通过指定脚本分析计算工作流的每个步骤
$mpint_flow analyze_project-i project_file.yaml
想要开发和贡献，我们建议从github存储库获取最新的拷贝。
如果您已经有了本地拷贝，可以跳过以下说明的步骤1和2
。只需从mpinterfaces文件夹中执行"git pull"，然后转到
步骤3（如果本地副本是以开发模式安装的，也可以跳过此步骤）。
注意：在您自己的计算机上使用虚拟环境时，我们建议使用miniconda。
1。从github克隆最新版本
-git克隆https://github.com/henniggroup/mpinterfaces.git
2。CD接口
>3。python setup.py安装（或开发）
4。将mpint_config.yaml文件从config_files/mpint_config.yaml
复制到mpinterfaces/mpint_config.yaml
，并更新该文件，以便您具有以下环境变量：
-mapi_key=从MaterialsProject获取的_key
-pmg_vasp_psp dir=path_to_vasp_potcar_files
>如何安装最新的pymatgen
=--
请参见http://pymatgen.org/获取pymatgen
文档
===
并且正在进行改进工作。
usage
=
我们对所有结构操作任务使用pymatgen工具，因此最好从这里开始：
http://pymatgen.org/使用pymatgen
examples文件夹包含一些示例scr演示mpinterface和materialsproject包的
用法的ipt。有关基本的
用法，请参阅**docs/usage.rst**。
_ MPinterfaces-paper:http://www.sciencedirect.com/science/article/pii/s092702561630244
许可证
==
eReby免费授予获得本软件和相关文档文件（以下简称"软件"）副本的任何人，以无限制地使用本软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可的权利。SE和/或出售
软件的副本，并允许向其提供软件的人员这样做，
但须遵守以下条件：
软件。
软件按"原样"提供，无任何明示或暗示的保证，包括但不限于对适销性、适用性和非侵权性的保证。在任何情况下，作者或
版权所有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权诉讼或其他诉讼中，因
与软件或软件的使用或其他交易有关，或因
与软件或软件的使用或其他交易有关而引起的。
=
=
>我们试图遵循pymatgen（pep8）所使用的编码风格：
阿鲁尼马辛格
<
约书亚·T·保罗
欢迎加入QQ群-->： 979659372
