shivupa/cclib-ci

cclib测试镜像文档

镜像概述

本Docker镜像专为测试cclib库设计。cclib是一个用于解析计算化学软件（如Gaussian、NWChem、ORCA等）输出文件的Python库，该镜像集成了cclib及其测试所需的全部依赖，旨在为开发者和用户提供快速、一致的测试环境，无需手动配置复杂的依赖关系。

核心功能与特性

• 预配置环境：已安装cclib库及其测试依赖（如pytest、numpy、scipy等），开箱即可使用
• 集成测试资源：包含cclib官方测试数据集，覆盖多种计算化学软件的输出格式
• 多测试模式支持：支持单元测试、集成测试及自定义测试脚本执行
• 轻量级设计：基于Python官方镜像构建，体积小巧，启动快速
• 兼容性保障：定期更新以适配cclib最新版本及依赖库版本

使用场景

• cclib开发：开发者验证新版本功能正确性、修复bug后回归测试
• 用户验证：用户测试自定义计算化学输出文件的解析效果
• 教学演示：在教学环境中展示cclib解析不同计算化学软件输出的能力
• CI/CD集成：作为持续集成流程的一部分，自动化验证cclib代码变更

使用方法与配置说明

基本使用

通过以下命令启动镜像并进入交互式终端：

bash
docker run -it --rm docker.xuanyuan.run/cclib/testing

说明：--rm 选项确保容器退出后自动清理，避免残留临时文件

运行官方测试

容器启动后，可直接执行cclib官方测试套件：

bash
pytest /usr/local/lib/python3.x/site-packages/cclib/tests/

注意：将python3.x替换为容器内实际Python版本（可通过python --version查看）

挂载自定义测试文件

如需测试本地计算化学输出文件，可通过 -v 参数挂载本地目录：

bash
docker run -it --rm -v /path/to/local/testfiles:/testfiles docker.xuanyuan.run/cclib/testing

在容器内解析自定义文件：

python
from docker.xuanyuan.run/cclib.io import ccopen
data = ccopen("/testfiles/my_output.log").parse()
print(data)  # 输出解析结果

环境变量配置

示例：启用详细测试输出

bash
docker run -it --rm -e CCLIB_TEST_VERBOSITY=3 docker.xuanyuan.run/cclib/testing

docker-compose配置

创建docker-compose.yml简化测试流程：

yaml
version: '3'
services:
  cclib-test:
    image: docker.xuanyuan.run/cclib/testing
    volumes:
      - ./local_testfiles:/testfiles
    environment:
      - CCLIB_TEST_VERBOSITY=2
    command: pytest /usr/local/lib/python3.x/site-packages/cclib/tests/

启动测试：

bash
docker-compose up