aiida-codtools

这是cod-tools的官方AiiDA插件。

兼容性矩阵

以下表格显示aiida-codtools的哪些版本与AiiDA和Python的哪些版本兼容。

插件	AiiDA	Python
v3.0.0 < v4.0.0
v2.2.0 < v3.0.0
v2.1.0 < v2.2.0
v2.0.0 < v2.1.0
v1.0.0 < v2.0.0

安装

要从PyPi安装，只需执行

pip install aiida-codtools

或从源代码安装时

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

开始使用

为了使用aiida-codtools，在安装包后，需要设置和配置aiida-core。有关说明，请参阅aiida-core的文档。

该包提供了一个命令行脚本aiida-codtools，其中包含一些有用的命令，例如启动计算或导入CIF文件。使用--help标志调用命令以显示其用法

Usage: aiida-codtools [OPTIONS] COMMAND [ARGS]...

  CLI for the `aiida-codtools` plugin.

Options:
  -p, --profile PROFILE  Execute the command for this profile instead of the default profile.
  -h, --help             Show this message and exit.

Commands:
  calculation  Commands to launch and interact with calculations.
  data         Commands to import, create and inspect data nodes.
  workflow     Commands to launch and interact with workflows.

每个子命令可以拥有多个其他子命令。要启用自动补全，请将以下行添加到您的shell激活脚本中

eval "$(_AIIDA_CODTOOLS_COMPLETE=source aiida-codtools)"

例如，要从COD数据库导入10个随机的CIF文件，您可以这样做

verdi group create cod_cif_raw
aiida-codtools data cif import -d cod -G cod_cif_raw -M 10

在配置好计算机和代码后，您也可以通过AiiDA轻松启动cod-tools计算

aiida-codtools calculation launch cod-tools -X cif-filter -N 10

在这里，cif-filter是您配置的代码标签，而10是CifData节点的pk。这些值可能因您的数据库而异，因此请相应地更改它们。

文档

有关此包的文档可在readthedocs上找到。

致谢

本工作部分得到swissuniversities P-5项目“材料云”的支持。