aiida-aurora

用于Aurora项目（自主机器人电池创新平台）的AiiDA插件。EPFL & Empa在2021-2023年BIG-MAP利益相关者倡议中合作的项目。

仓库内容

• .github/: Github Actions 配置
  • ci.yml: 每次新提交时运行测试、检查测试覆盖率和构建文档
  • publish-on-pypi.yml：自动将 Git 标签部署到 PyPI - 只需为您的 PyPI 账户生成一个 PyPI API 令牌 并将其添加到 GitHub 仓库的 pypi_token 秘密中
• aiida_aurora/：插件包的主要源代码
  • data/：一个新的 DiffParameters 数据类，用作 DiffCalculation CalcJob 类的输入
  • calculations.py：一个新的 DiffCalculation CalcJob 类
  • cli.py：扩展了 verdi data 命令行界面以支持 DiffParameters 类
  • helpers.py：用于自动设置 AiiDA 代码的辅助函数，用于 diff
  • parsers.py：为 DiffCalculation 新增的 Parser
• docs/：准备好在 Read the Docs 上发布的文档模板
• examples/：使用此插件提交计算的示例
• tests/：使用 pytest 框架的基本回归测试（提交计算等）。安装 pip install -e .[testing] 并运行 pytest。
• .coveragerc：配置 coverage.py 工具，报告哪些插件行被测试覆盖
• .gitignore：告诉 git 忽略哪些文件
• .pre-commit-config.yaml：配置 pre-commit hooks 以清理代码风格和检查语法错误。通过 pip install -e .[pre-commit] && pre-commit install 启用
• .readthedocs.yml：配置 Read the Docs 的文档构建
• LICENSE：插件许可
• MANIFEST.in：配置要包含在 PyPI 发布中的非 Python 文件
• README.md：此文件

安装

pip install aiida-aurora
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 running
cd examples
./example_01.py        # run test calculation
verdi process list -a  # check record of calculation

该插件还包括用于检查其数据类型的 verdi 命令

verdi data aurora list
verdi data aurora export <PK>

开发

git clone https://github.com/EmpaEconversion/aiida-aurora .
cd aiida-aurora
pip install -e .[pre-commit,testing]  # install extra dependencies
pre-commit install  # install pre-commit hooks
pytest -v  # discover and run all tests

有关更多信息，请参阅 开发者指南

许可协议

MIT

致谢

本项目得到 ETH 董事会开放研究数据计划的支持。

联系方式

• Edan Bainglass (edan.bainglass@psi.ch)
• Francisco F. Ramirez (ramirezfranciscof@gmail.com)
• Loris Ercole (loris.ercole@gmail.com)
• Giovanni Pizzi (giovanni.pizzi@psi.ch)