aiida-flexpart

AiiDA插件用于FLEXPART代码（大气传输过程模拟）。

此插件是AiiDA插件切割器的默认输出，旨在帮助开发人员开始他们的AiiDA插件。

存储库内容

• .github/: Github Actions配置
  • ci.yml: 在每个新提交时运行测试、检查测试覆盖率并构建文档
  • publish-on-pypi.yml: 自动将git标签部署到PyPI - 只需为您在PyPI账户上生成PyPI API令牌并将其添加到您的github存储库的pypi_token秘密中
• aiida_flexpart/: 插件包的主要源代码
  • 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：此文件
• conftest.py：pytest 的 fixtures 配置
• pytest.ini：pytest 测试发现的配置
• setup.json：插件元数据，用于在 PyPI 和 AiiDA 插件注册表 上注册（包括入口点）
• setup.py：pip / PyPI 的安装脚本

还可以参考以下 2019-05 AiiDA 教程的视频序列

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

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

功能

• 使用 SinglefileData 添加输入文件

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

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

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

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

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

安装

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

开发

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

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

许可证

MIT

联系方式

aliaksandr.yakutovich@empa.ch