aiida-gulp

运行GULP代码的AiiDA插件。

文档： https://readthedocs.org/projects/aiida-gulp

安装

要从Conda安装（推荐）：

>> conda install -c conda-forge aiida-gulp aiida-core.services

要从PyPI安装：

>> pip install aiida-gulp

要安装开发版本

>> git clone https://github.com/chrisjsewell/aiida-gulp .
>> cd aiida-gulp
>> pip install -e .  # also installs aiida, if missing (but not postgres)
>> #pip install -e .[pre-commit,testing] # install extras for more features
>> verdi quicksetup  # set up a new profile
>> verdi calculation plugins  # should now show the calculation plugins (with prefix gulp.)

开发

针对模拟GULP可执行文件进行测试

由于GULP是许可软件，因此无法在Travis CI上获取可执行文件的副本。因此，已创建模拟可执行文件（gulp_mock）用于测试目的（这也有助于加快测试运行）。

此可执行文件计算提供的输入文件的md5哈希值，并尝试将其与预计算的哈希值字典相匹配。如果找到匹配项，则可执行文件将匹配的输出（来自test/output_files）写入stdout。

以下将发现并运行所有单元测试

>> pip install -e .[testing]
>> reentry scan -r aiida
>> pytest -v

要省略调用外部可执行文件（如gulp）的测试

>> pytest --gulp-skip-exec

要调用实际可执行文件（例如，使用gulp而不是gulp_mock）

>> pytest --gulp-no-mock

要将calcjob执行结果输出到特定目录

>> pytest --gulp-workdir "test_workdir"

编码风格要求

代码风格通过flake8进行测试，配置设置在.flake8中，代码应使用black格式化。

使用aiida-gulp[code_style]安装将使pre-commit包可用，这将确保通过重新格式化代码并在提交之前进行lint错误测试来通过这些测试。它可以通过以下方式设置：

>> cd aiida-gulp
>> pre-commit install

可选地，您可以单独运行black和flake8

>> black .  # recursively find and format files in-place
>> flake8

编辑器如VS Code也具有自动代码格式化工具，可以遵循此标准。

许可证

查看LICENSE文件

联系

chrisj_sewell@hotmail.com