aiida-quantum-transport

基于NEGF方法的量子输运计算插件。

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

仓库内容

• .github/: Github Actions 配置
  • ci.yml: 每次新提交时运行测试、检查测试覆盖率和构建文档
  • publish-on-pypi.yml: 自动将git标签部署到PyPI - 只需为您的PyPI账户生成PyPI API令牌并将其添加到github仓库的pypi_token密钥中
• src/aiida_quantum_transport/: 插件包的主要源代码
  • data/: 自定义数据类
  • calculations.py: 量子输运AiiDA计算类
  • cli.py: 定制的 verdi CLI命令
  • helpers.py: 设置AiiDA代码的辅助工具
  • parsers.py：自定义解析器类
• docs/：插件的文档
• tests/：使用pytest框架的基本回归测试（提交计算，...）。安装 pip install -e .[testing] 并运行 pytest。
  • conftest.py：pytest的固定配置
• .gitignore：告诉git忽略哪些文件
• .pre-commit-config.yaml：配置pre-commit钩子，用于清理编码风格和检查语法错误。通过 pip install -e .[pre-commit] && pre-commit install 启用
• .readthedocs.yml：Read the Docs的文档构建配置
• LICENSE：插件的许可证
• README.md：此文件
• pyproject.toml：Python包元数据，用于在PyPI和AiiDA插件注册表上注册（包括入口点）

功能

开发中

安装

pip install aiida-quantum-transport
verdi quicksetup
verdi plugin list aiida.calculations

用法

以下是如何使用此插件提交测试计算的完整示例。

提交计算的一个快速演示

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

开发

git clone https://github.com/edan-bainglass/aiida-quantum-transport .
cd aiida-quantum-transport
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

联系

edan.bainglass@gmail.com