跳转到主要内容

官方AiiDA插件,用于Quantum ESPRESSO

项目描述

aiida-quantumespresso

PyPI version PyPI pyversions Build Status Docs status

这是官方AiiDA插件,用于Quantum ESPRESSO

兼容性矩阵

以下矩阵假设用户始终安装指定次要版本的最新补丁版本,这是推荐的。

插件 AiiDA Python Quantum ESPRESSO
v4.0 < v5.0 Compatibility for v4.0 PyPI pyversions Quantum ESPRESSO compatibility
v3.5 < v4.0 Compatibility for v3.5 PyPI pyversions Quantum ESPRESSO compatibility
v3.4 < v3.5 Compatibility for v3.4 PyPI pyversions Quantum ESPRESSO compatibility
v3.3 < v3.4 Compatibility for v3.3 PyPI pyversions Quantum ESPRESSO compatibility
v3.1 < v3.3 Compatibility for v3.1 Quantum ESPRESSO compatibility
v3.0 < v3.1 Compatibility for v3.0 Quantum ESPRESSO compatibility
v2.0 < v3.0 Compatibility for v2.0 Quantum ESPRESSO compatibility

aiida-quantumespresso==4.0开始,支持Quantum ESPRESSO的最后三个次要版本。旧版本支持最多两年。

安装

要从PyPI安装,只需执行

pip install aiida-quantumespresso

或从源码安装时

git clone https://github.com/aiidateam/aiida-quantumespresso
pip install aiida-quantumespresso

命令行界面工具

插件自带内置CLI工具:aiida-quantumespresso。此工具使用click库构建,并支持自动补全。要启用它,将以下内容添加到您的shell加载脚本中,例如.bashrc或虚拟环境激活脚本

eval "$(_AIIDA_QUANTUMESPRESSO_COMPLETE=source aiida-quantumespresso)"

该工具附带各种子命令,例如快速启动某些计算和工作流程。例如,要启动测试PwCalculation,可以运行以下命令

aiida-quantumespresso calculation launch pw -X pw-v6.1 -F SSSP/1.1/PBE/efficiency

请注意,这需要配置代码pw-v6.1和伪势能族SSSP/1.1/PBE/efficiency。有关如何轻松安装它们的说明,请参阅伪势能部分。每个命令都有完整的命令行界面文档,可以使用帮助标志打印到屏幕上

aiida-quantumespresso calculation launch ph --help

它应该打印出以下内容

Usage: aiida-quantumespresso calculation launch ph [OPTIONS]

  Run a PhCalculation.

Options:
  -X, --code CODE                 A single code identified by its ID, UUID or
                                  label.  [required]
  -C, --calculation CALCULATION   A single calculation identified by its ID or
                                  UUID.  [required]
  -k, --kpoints-mesh INTEGER...   The number of points in the kpoint mesh
                                  along each basis vector.  [default: 1, 1, 1]
  -m, --max-num-machines INTEGER  The maximum number of machines (nodes) to
                                  use for the calculations.  [default: 1]
  -w, --max-wallclock-seconds INTEGER
                                  the maximum wallclock time in seconds to set
                                  for the calculations.  [default: 1800]
  -i, --with-mpi                  Run the calculations with MPI enabled.
                                  [default: False]
  -d, --daemon                    Submit the process to the daemon instead of
                                  running it locally.  [default: False]
  -h, --help                      Show this message and exit.

伪势能

伪势能通过 aiida-pseudo 插件 安装和管理。安装伪势能的最简单方法是使用 aiida-pseudo 的 CLI 安装一个 SSSP 版本。只需运行

aiida-pseudo install sssp

来安装默认的 SSSP 版本。使用 aiida-pseudo list 命令列出已安装的伪势能族。然后您可以在命令行中使用 -F 标志使用任何族的名称。

许可证

aiida-quantumespresso 插件包采用 MIT 许可证发布。有关更多详细信息,请参阅 LICENSE.txt 文件。

致谢

我们感谢以下机构的支持:

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源分布

aiida-quantumespresso-test-4.0.0a1.tar.gz (647.2 kB 查看哈希值)

上传时间

构建分布

aiida_quantumespresso_test-4.0.0a1-py3-none-any.whl (731.4 kB 查看哈希值)

上传时间 Python 3

支持者