运行gulpmd代码的AiiDA插件
aiida-gulp的Python项目详细描述
阿依达咕噜
运行GULP代码的AiiDA插件。在
文档:https://readthedocs.org/projects/aiida-gulp
安装
从Conda安装(推荐):
>> conda install -c conda-forge aiida-gulp aiida-core.services
从pypi安装:
^{pr2}$要安装开发版本:
>> 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.)
发展
针对mock 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
和{
>> black . # recursively find and format files in-place
>> flake8
像VS代码这样的编辑器也有自动代码重新格式化实用程序,它可以遵守这个标准。在
许可证
请参阅LICENSE
文件
联系人
- 项目
标签: