开发的AiiDA插件和工作链纳米技术@表面Empa小组。
aiida-nanotech-empa的Python项目详细描述
aiida纳米技术empa
包含插件/工作链的AiiDA插件纳米技术@表面Empa小组。在
此插件是 AiiDA plugin cutter, 旨在帮助开发人员开始使用他们的AiiDA插件。在
存储库内容
- ^{
} :Github Actions配置- ^{
} :在每次新提交时运行测试、检查测试覆盖率并生成文档 - ^{
} :自动将git标记部署到PyPI-只需为PyPI帐户生成一个PyPI API token并将其添加到github存储库的pypi_token
机密中
- ^{
- ^{
} :插件包的主要源代码 在 - ^{
} :准备在Read the Docs上发布的文档模板 - ^{
} :使用此插件提交计算的示例 - ^{
} :使用pytest框架的基本回归测试(提交计算,…)。安装pip install -e .[testing]
并运行pytest
。在 - ^{
} :配置coverage.py工具,报告测试覆盖了插件的哪些行 - ^{
} :告诉git要忽略哪些文件 - ^{
} :清理编码样式并检查语法错误的{a26}配置。通过pip install -e .[pre-commit] && pre-commit install
启用 - ^{
} :为Read the Docs配置文档生成 - ^{
} :插件的许可证 - ^{
} :配置要包括在PyPI上发布的非Python文件 - ^{
} :此文件 - ^{
} :为{a21}配置夹具 - ^{
} :测试发现{a21}的配置 - ^{
} :在PyPI和AiiDA plugin registry上注册的插件元数据(包括入口点) - ^{
} :pip/PyPI的安装脚本
有关更多信息,请参阅插件的developer guide。在
特点
- 在
使用
SinglefileData
添加输入文件:SinglefileData=DataFactory('singlefile')inputs['file1']=SinglefileData(file='/path/to/file1')inputs['file2']=SinglefileData(file='/path/to/file2')
在 - 在
通过python字典和
^{pr2}$ 在DiffParameters
指定命令行选项: - 在
DiffParameters
字典使用voluptuous进行验证。 了解支持的选项:DiffParameters=DataFactory('nanotech_empa')print(DiffParameters.schema.schema)
在
安装
pip install aiida-nanotech-empa verdi quicksetup # better to set up a new profile verdi plugin list aiida.calculations # should now show your calclulation plugins
使用
这里有一个完整的例子来说明如何使用这个插件提交一个测试计算。在
如何提交计算的快速演示:
verdi daemon start # make sure the daemon is runningcd examples ./example_01.py # run test calculation verdi process list -a # check record of calculation
该插件还包含用于检查其数据类型的verdi命令:
verdi data nanotech_empa list
verdi data nanotech_empa export <PK>
发展
git clone https://github.com/yakutovicha/aiida-nanotech-empa . cd aiida-nanotech-empa pip install -e .[pre-commit,testing]# install extra dependencies pre-commit install # install pre-commit hooks pytest -v # discover and run all tests
有关详细信息,请参阅developer guide。在
许可证
麻省理工学院
- 项目
标签: