biocontainers/toppas

BioContainers 镜像文档

最新信息请访问 [***]

容器库

已审核的生物信息学容器仓库

链接

• 网页：[***]
• 项目定义：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
• ****：

许可证

http://www.apache.org/licenses/LICENSE-2.0

目录

1. 基本信息
   1.1. 什么是BioContainers
   1.2. 目标与宗旨
2. 容器
   2.1. 什么是容器
   2.2. 为什么需要使用容器
   2.3. 如何使用BioContainer
   2.4. BioContainers架构
   2.4.1 如何请求容器
   2.4.2 使用容器
3. 开发容器
   3.1. 开发所需条件
   3.2. 如何创建容器
4. 支持
   4.1 参与贡献

1. 基本信息

1.1. 什么是BioContainers？

BioContainers项目源于将Docker或rkt等容器技术应用于生物信息学软件的想法。通过提供可控的统一运行环境，可解决软件开发与分发过程中的部分现有问题。BioContainers是社区驱动的项目，提供基础设施和基本指南，用于创建、管理和分发生物信息学容器，特别关注蛋白质组学、基因组学、转录组学和代谢组学等组学领域。已实现的主要容器（https://github.com/BioContainers/containers）包含详细说明及使用示例，可促进软件和算法的使用与重现性，能集成到更复杂的生物信息学流程中，适用于本地桌面、云环境或HPC集群等不同架构。项目同时提供创建新容器及贡献的指南和规范。

1.2. 目标与宗旨

• 提供基础规范和镜像，以便轻松构建和部署新的生物信息学/蛋白质组学软件，包括源代码和示例。
• 提供一系列可供生物信息学社区直接使用的容器（https://github.com/BioContainers/containers）。
• 定义一套指南和规范，用于构建可与其他容器及生物信息学工具结合使用的标准化容器。
• 构建完整的基础设施，使用Travis CI、Shippable等持续集成套件或手动构建方案开发、部署和测试新的生物信息学容器。
• 为缺乏生物信息学支持的研究人员提供部署新容器的支持和帮助。
• 提供指南和帮助，通过定义、重用和报告特定容器版本创建可重现流程，确保结果一致性并保留历史版本。
• 协调开发者和生物信息学家，制定文档和软件开发的最佳实践。

2. 容器

2.1. 什么是容器？

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

2.2. 为什么需要使用容器？

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

2.3. 如何使用BioContainer

BioContainers主要在两个 registry 中列出：

• https://hub.docker.com/u/biodckr/：基于Docker的容器，需使用Docker基础设施。
• https://quay.io/organization/biodckr：支持Docker和rkt的容器，可用于rkt基础设施。

完整使用文档请参见 http://BioDocker.org/docs。

2.4. BioContainers架构

BioContainers是社区驱动项目，支持生物信息学家使用容器请求、构建和部署生物信息学工具。下图展示了BioContainers的一般工作流程：

以下部分详细解释工作流程：

• (i) 如何请求容器
• (ii) 使用BioContainer
• (iii) 开发容器

2.4.1 如何请求容器

用户可通过在 http://github.com/BioContainers/sandbox/issues 提交issue请求容器（工作流程中用户henrik执行的第一步）。Issue需包含软件名称、代码或二进制文件URL及软件相关信息（参见http://github.com/BioContainers/container-specs.md）。容器部署并功能完备后，开发者或贡献者将关闭该issue。

2.4.2 使用容器

容器部署完成且开发者关闭GitHub issue后，用户（如henrik）将收到容器就绪通知。用户可使用http://www.docker.com或https://coreos.com/rkt/docs/latest/拉取相应容器。

3. 开发容器

3.1. 开发所需条件

BioContainers基于Linux系统，因此需安装Linux的计算机，以及docker或rkt守护进程，和待容器化的软件。

3.2. 如何创建容器

构建容器有两种方式：

• 前往目标软件的GitHub仓库，克隆其构建脚本，在本地机器自行构建。
• 使用docker守护进程搜索现成的容器化软件版本。

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

3.2.1 如何创建基于Docker的BioContainer

需创建Dockerfile，这是指导守护进程设置适当OS、下载、管理、安装软件并提供访问权限的简单脚本。可参考https://docs.docker.com/reference/builder/获取更多信息。容器就绪后，可联系项目团队安排自动化构建系统，使容器对社区开放。

3.2.2 如何创建基于rkt的BioContainer

需创建rkt容器脚本，指导守护进程设置适当OS、下载、管理、安装软件并提供访问权限。可参考https://github.com/coreos/rkt/blob/master/Documentation/getting-started-guide.md获取更多信息。容器就绪后，可联系项目团队安排自动化构建系统，使容器对社区开放。

4. 支持

4.1. 参与贡献

无论您是想将自己的软件以容器形式分享、在流程和分析中使用容器，还是提供意见，都非常欢迎参与。这是社区驱动项目，每个人都有发言权。

以下是一些参与方式：

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