aiidateam/aiida-core

AiiDA Docker镜像

!AiiDA

AiiDA（[***]

镜像概述

AiiDA旨在为计算科学研究提供自动化、可复现的工作流基础设施，通过Docker镜像可快速部署，无需复杂的环境配置，适用于各类计算科学场景。

关键信息

核心功能与特性

• 工作流管理：使用Python编写复杂的自动化文档工作流，链接本地和远程计算机上的任意可执行文件。基于事件的工作流引擎支持每小时数万个进程，并具备完整的 checkpointing 功能。

• 数据溯源追踪：自动跟踪所有计算的输入、输出和元数据，构建完整的溯源图以确保可复现性。支持对包含数百万节点的图进行快速查询。

• HPC系统接口：仅需修改一行代码即可将计算任务迁移到不同计算机。原生支持多种调度器，如SLURM、PBS Pro、torque、SGE和LSF。

• 插件扩展能力：通过https://aiidateam.github.io/aiida-registry/%E6%89%A9%E5%B1%95AiiDA%E5%8A%9F%E8%83%BD%EF%BC%8C%E6%94%AF%E6%8C%81%E6%96%B0%E7%9A%84%E6%A8%A1%E6%8B%9F%E4%BB%A3%E7%A0%81%EF%BC%88%E8%BE%93%E5%85%A5%E7%94%9F%E6%88%90%E4%B8%8E%E8%A7%A3%E6%9E%90%EF%BC%89%E3%80%81%E6%95%B0%E6%8D%AE%E7%B1%BB%E5%9E%8B%E3%80%81%E8%B0%83%E5%BA%A6%E5%99%A8%E5%92%8C%E4%BC%A0%E8%BE%93%E6%A8%A1%E5%BC%8F%E7%AD%89%E3%80%82

• 开放科学支持：导出部分溯源图并与同行共享，或通过Materials Cloud向公众开放。

• 开源许可：基于MIT开源许可证发布，允许自由使用和修改。

使用场景与适用范围

• 计算科学研究：适用于材料科学、凝聚态物理、化学等领域的计算模拟工作流管理。

• 高通量计算：支持大规模并行计算任务调度与管理，提高计算效率。

• 多HPC系统管理：统一管理不同HPC平台的计算资源，简化跨平台任务部署。

• 科研数据共享：通过溯源图实现研究数据的可复现性共享，促进开放科学。

使用方法与配置说明

基础部署（Docker Run）

bash
# 拉取镜像
docker pull docker.xuanyuan.run/aiidateam/aiida-core

# 启动容器（基础示例）
docker run -d \
  --name aiida-instance \
  -p 8888:8888 \  # Jupyter接口端口
  -v aiida-data:/home/aiida/.aiida \  # 持久化AiiDA数据
  aiidateam/aiida-core

Docker Compose配置（推荐）

创建docker-compose.yml文件：

yaml
version: '3'
services:
  aiida:
    image: docker.xuanyuan.run/aiidateam/aiida-core
    container_name: aiida-core
    ports:
      - "8888:8888"  # Jupyter notebook
      - "5000:5000"  # AiiDA REST API
    volumes:
      - aiida-data:/home/aiida/.aiida
      - ./plugins:/home/aiida/plugins  # 挂载自定义插件
    environment:
      - AIIDA_PROFILE=default
      - POSTGRES_HOST=db
      - POSTGRES_USER=aiida
      - POSTGRES_PASSWORD=aiida_db_password
      - POSTGRES_DB=aiidadb
    depends_on:
      - db

  db:
    image: docker.xuanyuan.run/postgres:13
    container_name: aiida-postgres
    environment:
      - POSTGRES_USER=aiida
      - POSTGRES_PASSWORD=aiida_db_password
      - POSTGRES_DB=aiidadb
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  aiida-data:
  postgres-data:

启动服务：

bash
docker-compose up -d

环境变量配置

初始化与使用

容器启动后，进入容器配置AiiDA：

bash
# 进入容器
docker exec -it aiida-instance bash

# 初始化AiiDA（首次运行）
verdi quicksetup

贡献与支持

• 贡献指南：欢迎通过PR参与开发，详情参见https://github.com/aiidateam/aiida-core/wiki%E3%80%82

• 常见问题：遇到安装或使用问题，可参考https://aiida-core.readthedocs.io/en/latest/howto/faq.html%E3%80%82

• 社区支持：通过https://groups.google.com/forum/#!forum/aiidausers%E6%88%96https://github.com/aiidateam/aiida-core/issues%E8%8E%B7%E5%8F%96%E5%B8%AE%E5%8A%A9%E3%80%82

引用与许可证

引用

若在研究中使用AiiDA，请引用以下文献：

• AiiDA >= 1.0：S. P. Huber et al., AiiDA 1.0, a scalable computational infrastructure for automated reproducible workflows and data provenance, Scientific Data 7, 300 (2020); DOI: https://doi.org/10.1038/s41597-020-00638-4

• AiiDA >= 1.0：M. Uhrin et al., Workflows in AiiDA: Engineering a high-throughput, event-based engine for robust and modular computational workflows, Computational Materials Science 187, *** (2021); DOI: https://doi.org/10.1016/j.commatsci.2020.***

• AiiDA < 1.0：Giovanni Pizzi et al., AiiDA: automated interactive infrastructure and database for computational science, Computational Materials Science 111, 218-230 (2016); DOI: https://doi.org/10.1016/j.commatsci.2015.09.013

许可证

AiiDA基于MIT开源许可证分发（详见LICENSE.txt）。第三方开源组件许可信息参见open_source_licenses.txt。

致谢

AiiDA是NumFOCUS附属项目，并得到MARVEL国家研究能力中心、MaX欧洲卓越中心及其他支持项目和机构的资助，完整致谢名单见AiiDA官网致谢页面。