aiidalab/qe

AiiDAlab Quantum ESPRESSO应用

概述

这是一个早期开发阶段的AiiDAlab应用，用于Quantum ESPRESSO工作流。该应用允许执行包含输入结构选择、结构弛豫和能带结构计算的Quantum ESPRESSO工作流。

注意：此应用目前处于早期开发阶段！

核心功能

• 支持Quantum ESPRESSO工作流执行
• 提供输入结构选择功能
• 集成结构弛豫计算步骤
• 支持能带结构计算

使用场景

适用于科研人员进行基于Quantum ESPRESSO的材料性质研究，特别是需要执行结构弛豫和能带结构计算的量子化学模拟场景。

开发者指南

前置要求

• Python环境
• Docker（用于集成测试）
• pre-commit（用于代码风格检查）

代码风格检查

该包使用pre-commit钩子检查所有提交的代码风格一致性。使用前需先安装pre-commit相关依赖：

bash
pip install .[dev]

然后安装pre-commit钩子：

bash
pre-commit install

安装后，pre-commit检查将在每次提交前自动执行。

单元测试

要在AiiDAlab容器中运行单元测试，需在aiida-core-services conda环境中执行pytest：

bash
conda activate aiida-core-services
pytest -sv tests

集成测试

运行集成测试前，需先构建Docker镜像：

bash
cd docker/
docker buildx bake -f build.json -f docker-bake.hcl --set "*.platform=linux/amd64" --load

构建完成后，执行以下命令运行集成测试：

bash
JUPYTER_TOKEN=max TAG=newly-baked pytest --driver Chrome tests_integration -sv

维护者指南

创建新版本

要创建新版本，需克隆仓库并安装开发依赖：

bash
pip install '.[dev]'

然后执行bumpver update命令：

bash
bumpver update

该命令将执行以下操作：

1. 创建带有更新版本号的标签发布，并推送到仓库
2. 触发GitHub Actions工作流，自动创建GitHub发布

注意事项

• 使用--dry选项可预览发布变更，而不实际执行
• 发布标签（如a/b/rc）由上一个版本决定，可使用--tag选项手动切换发布标签类型

致谢

本项目获得欧盟"地平线2020"研究与创新计划资助（资助协议编号：957189），是BATTERY 2030+大型欧洲研究计划的一部分，旨在研发未来可持续电池。同时得到以下机构支持：

• 瑞士国家科学基金会资助的MARVEL国家研究能力中心
• 地平线2020计划H2020-NMBP-25-2017号召资助的MARKETPLACE项目（资助编号：760173）
• Horizon 2020 EINFRA-5计划资助的MaX欧洲卓越中心（资助编号：676598）