biocontainers/crux

BioContainers 镜像文档

1. 概述

1.1 什么是BioContainers？

BioContainers项目源于使用Docker或rkt等容器技术处理生物信息学软件的想法。通过提供可控的统一运行环境，解决软件开发与分发中的问题。这是一个社区驱动项目，专注于为蛋白质组学、基因组学、转录组学和代谢组学等组学领域提供容器化基础设施和规范，已实现的容器可在本地桌面、云环境或HPC集群中使用，支持构建可重复的生物信息学流程。

1.2 目标与目的

• 提供基础规范和镜像，便于构建和部署生物信息学/蛋白质组学软件，包含源代码和示例
• 提供一系列可供生物信息学社区直接使用的容器（https://github.com/BioContainers/containers%EF%BC%89
• 定义标准化容器构建指南和规范，确保容器可与其他工具协同使用
• 建立完整的容器开发、部署和测试基础设施，支持Travis CI、Shippable等持续集成工具
• 为缺乏生物信息学支持的研究人员提供容器部署支持和帮助
• 提供通过指定容器版本创建可重复流程的指南，确保结果一致性和历史可追溯性
• 协调开发者和生物信息学家，制定文档和软件开发最佳实践

2. 容器

2.1 什么是容器？

容器基于现有操作系统构建，与虚拟机不同，容器不包含完整的 guest OS，而是使用优化的系统库并依托宿主OS的内存管理和进程控制。容器通常围绕特定软件构建，可通过实例化镜像执行。

2.2 为什么需要使用容器？

生物信息学分析通常需要安装和配置多个工具，此过程可能耗时数小时，且需处理众多依赖。BioContainers提供即用型工具包，可轻松部署于本地机器、HPC和云架构。

2.3 如何使用BioContainer？

BioContainers主要在两个仓库中列出：

• https://hub.docker.com/u/biodckr/%EF%BC%9A%E5%9F%BA%E4%BA%8EDocker%E7%9A%84%E5%AE%B9%E5%99%A8%EF%BC%8C%E9%9C%80%E4%BD%BF%E7%94%A8Docker%E5%9F%BA%E7%A1%80%E8%AE%BE%E6%96%BD
• QUAY Hub：支持Docker和rkt的容器，可用于rkt基础设施

完整使用文档请参见BioDocker文档

2.4 BioContainers架构

BioContainers是社区驱动项目，支持生物信息学家请求、构建和部署生物信息学工具容器。工作流程如下：

2.4.1 如何请求容器

用户可通过在http://github.com/BioContainers/sandbox/issues%E6%8F%90%E4%BA%A4issue%E8%AF%B7%E6%B1%82%E5%AE%B9%E5%99%A8%EF%BC%8C%E9%9C%80%E5%8C%85%E5%90%AB%E8%BD%AF%E4%BB%B6%E5%90%8D%E7%A7%B0%E3%80%81%E4%BB%A3%E7%A0%81%E6%88%96%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6URL%E5%8F%8A%E8%BD%AF%E4%BB%B6%E4%BF%A1%E6%81%AF%EF%BC%88%E5%8F%82%E8%A7%81http://github.com/BioContainers/container-specs.md%EF%BC%89%E3%80%82%E5%AE%B9%E5%99%A8%E9%83%A8%E7%BD%B2%E5%AE%8C%E6%88%90%E5%90%8E%EF%BC%8C%E5%BC%80%E5%8F%91%E8%80%85%E6%88%96%E8%B4%A1%E7%8C%AE%E8%80%85%E5%B0%86%E5%85%B3%E9%97%AD%E8%AF%A5issue%E3%80%82

2.4.2 使用BioContainer

容器部署完成且GitHub issue关闭后，用户将收到通知。此时可使用docker或rkt拉取相应容器。

3. 开发容器

3.1 如何构建BioContainer？

有两种构建容器的方式：

• 克隆目标软件的GitHub仓库，在本地构建
• 使用docker daemon搜索现成的容器化软件版本

中央仓库中包含带有docker recipe的软件列表，可获取更多使用信息。

3.2 开发所需环境

BioContainers基于Linux系统，需准备：

• 安装Linux的计算机
• docker或rkt daemon
• 待容器化的软件

3.3 如何创建基于Docker的BioContainer？

需创建Dockerfile，这是指导daemon设置操作系统、下载、管理、安装软件并提供访问权限的配方。可参考Docker文档获取更多信息。容器就绪后，可联系项目团队通过自动化构建系统将其发布给社区。

3.4 如何创建基于rkt的BioContainer？

需创建rkt容器配方，指导daemon设置操作系统、下载、管理、安装软件并提供访问权限。可参考https://github.com/coreos/rkt/blob/master/Documentation/getting-started-guide.md%E8%8E%B7%E5%8F%96%E6%9B%B4%E5%A4%9A%E4%BF%A1%E6%81%AF%E3%80%82%E5%AE%B9%E5%99%A8%E5%B0%B1%E7%BB%AA%E5%90%8E%EF%BC%8C%E5%8F%AF%E8%81%94%E7%B3%BB%E9%A1%B9%E7%9B%AE%E5%9B%A2%E9%98%9F%E9%80%9A%E8%BF%87%E8%87%AA%E5%8A%A8%E5%8C%96%E6%9E%84%E5%BB%BA%E7%B3%BB%E7%BB%9F%E5%B0%86%E5%85%B6%E5%8F%91%E5%B8%83%E7%BB%99%E7%A4%BE%E5%8C%BA%E3%80%82

4. 支持

4.1 参与方式

无论您希望将自己的软件容器化、在流程中使用容器，还是提供意见，都欢迎参与。这是社区驱动项目，每个人都有发言权。建议参与方式：

• 浏览容器列表
• 提出新想法或软件建议
• 若发现缺失功能，与其他成员交流

链接

• 网页：[***]
• 项目定义：https://github.com/BioContainers/specs
• 贡献规则：https://github.com/BioContainers/specs/blob/master/CONTRIBUTING.md
• 项目Wiki：https://github.com/BioContainers/specs/wiki
• 容器：https://github.com/BioContainers/containers
• 容器开发：https://github.com/BioContainers/sandbox
• ：

许可证

Apache 2