aiida-diff

AiiDA演示插件，用于包装diff可执行文件，以计算两个文件之间的差异。

此插件是AiiDA插件切割器的默认输出，旨在帮助开发者开始使用AiiDA插件。

仓库内容

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

另请参阅2019-05 AiiDA教程中的以下视频序列

• 运行aiida-diff示例计算
• aiida-diff CalcJob插件
• aiida-diff Parser插件
• aiida-diff计算机/代码辅助工具
• aiida-diff输入数据（带验证）
• aiida-diff CLI
• aiida-diff测试
• 将您的插件添加到注册表
• pre-commit hooks

有关更多信息，请参阅您插件的开发者指南。

功能

• 使用SinglefileData添加输入文件

  SinglefileData = DataFactory('core.singlefile')
  inputs['file1'] = SinglefileData(file='/path/to/file1')
  inputs['file2'] = SinglefileData(file='/path/to/file2')
  

• 通过Python字典和DiffParameters指定命令行选项

  d = { 'ignore-case': True }
  DiffParameters = DataFactory('diff')
  inputs['parameters'] = DiffParameters(dict=d)
  

• DiffParameters字典使用voluptuous进行验证。了解支持的选项

  DiffParameters = DataFactory('diff')
  print(DiffParameters.schema.schema)
  

安装

pip install aiida-diff
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 diff list
verdi data diff export <PK>

开发

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

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

许可证

MIT