概览
QCArchive 是用于组织量子化学计算及其生成数据的基础设施。该项目描述的工作流程涵盖计算执行、数据库存储、检索、分析、共享和导出。其声明的设计范围是数千至数百万次计算;这是来源描述的目标,并非所提供摘录证实的基准测试结果。对于计算化学家而言,它的作用是将计算执行与对累积数据的持久访问连接起来。
该代码仓库包含四个独立的 Python 软件包。qcfractal 提供 QCFractal 服务器,包括数据库和 Web API。qcportal 是用于与该服务器交互的 Python 客户端,而 qcfractalcompute 提供用于执行计算的可部署工作器。qcarchivetesting 包含用于测试 QCArchive 组件的辅助工具和 pytest 测试框架。这种划分使该代码仓库同时适用于客户端数据访问和底层计算基础设施的部署。
在工作流程层面,QCArchive 处理量子化学计算,并存储其数据以供后续使用。项目 README 未说明分子输入架构、支持的计算引擎、结果字段或导出格式,因此在规划集成之前,需要查阅链接文档核实这些细节。这些软件包放在同一个单体代码仓库中,因为各组件之间的更改紧密关联,但它们仍各自保留独立的软件包设置信息。现有摘录说明了其架构和代码仓库安装方式,但未说明部署要求或经测量的扩展性能。
主要功能
- QCFractal 服务器将数据库与 Web API 结合,用于管理量子化学计算数据。
- `qcportal` 提供用于与服务器交互的 Python 客户端。
- `qcfractalcompute` 提供可部署的工作器来运行计算。
- 存储的计算数据可供检索、共享、分析或导出。
- `qcarchivetesting` 提供用于测试 QCArchive 组件的辅助工具和 pytest 测试框架。
- 一个单体代码仓库包含四个紧密相关的 Python 软件包,每个软件包都有各自的设置信息。
使用场景
- 预期评估:评估 QCArchive 是否适合作为由数据库支持的执行和存储层,用于处理大量量子化学计算。
- 预期评估:使用 `qcportal` 评估如何检索已存储的计算数据,以供下游科学分析使用。
- 预期评估:将服务器、工作器和客户端软件包结合起来,评估其是否适用于共享或导出累积计算数据的工作流程。
- 预期评估:开发涉及多个 QCArchive 组件的更改时,了解所提供的测试辅助工具。
使用方式
- 先阅读代码仓库 README,了解四个软件包的布局,并确定评估重点是客户端访问、服务器部署、工作器执行还是组件测试。
- 查阅官方文档,了解输入表示形式、计算设置和部署指南。项目 README 摘录未包含这些细节。
- 如果从代码仓库安装,请按照其中针对
qcportal、qcfractal、qcfractalcompute和qcarchivetesting记录的 pip 安装说明操作。README 还提供了用于开发的可编辑安装方式。 - 在考虑其声明的大规模设计范围之前,先规划一项小规模、有代表性的评估。检查计算如何进入工作流程、工作器如何执行计算,以及客户端如何访问已存储的数据。
- 根据预期的分析需求评估检索、共享或导出功能,并将代码许可证与任何数据或服务条款分开查阅。