biocontainers/searchgui

BioContainers 镜像文档

1. 概述

1.1 什么是BioContainers？

BioContainers项目源于使用Docker或rkt等容器技术处理生物信息学软件的想法。通过提供可控的统一运行环境，解决生物信息学软件开发与分发中的问题。作为社区驱动项目，BioContainers提供基础设施和基本指南，用于创建、管理和分发生物信息学容器，特别关注蛋白质组学、基因组学、转录组学和代谢组学等组学领域。已实现的容器（https://github.com/BioContainers/containers%EF%BC%89%E5%8F%AF%E4%BF%83%E8%BF%9B%E8%BD%AF%E4%BB%B6%E5%92%8C%E7%AE%97%E6%B3%95%E7%9A%84%E4%BD%BF%E7%94%A8%E4%B8%8E%E5%8F%AF%E9%87%8D%E5%A4%8D%E6%80%A7%EF%BC%8C%E8%83%BD%E9%9B%86%E6%88%90%E5%88%B0%E6%9B%B4%E5%85%A8%E9%9D%A2%E7%9A%84%E7%94%9F%E7%89%A9%E4%BF%A1%E6%81%AF%E5%AD%A6%E7%AE%A1%E9%81%93%E5%8F%8A%E4%B8%8D%E5%90%8C%E6%9E%B6%E6%9E%84%EF%BC%88%E6%9C%AC%E5%9C%B0%E6%A1%8C%E9%9D%A2%E3%80%81%E4%BA%91%E7%8E%AF%E5%A2%83%E6%88%96HPC%E9%9B%86%E7%BE%A4%EF%BC%89%E4%B8%AD%E3%80%82

1.2 目标与宗旨

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

2. 容器

2.1 什么是容器？

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

!https://github.com/BioContainers/specs/blob/master/imgs/container.png

2.2 为何需要使用容器？

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

2.3 如何使用BioContainer？

BioContainers主要在两个 registry 中列出：

• Docker Hub：https://hub.docker.com/u/biodckr/%EF%BC%8C%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%E3%80%82
• QUAY Hub：[***]

有关使用BioContainers进行生物信息学分析的完整文档，请查看完整文档。

2.4 BioContainers架构

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

!https://github.com/BioContainers/specs/blob/master/imgs//workflow.png

以下章节详细解释工作流程：

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

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%88%E5%B7%A5%E4%BD%9C%E6%B5%81%E7%A8%8B%E4%B8%AD%E7%94%A8%E6%88%B7henrik%E6%89%A7%E8%A1%8C%E7%9A%84%E7%AC%AC%E4%B8%80%E6%AD%A5%EF%BC%89%E3%80%82issue%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%B6%E7%9A%84URL%EF%BC%8C%E4%BB%A5%E5%8F%8A%E8%BD%AF%E4%BB%B6%E7%9B%B8%E5%85%B3%E4%BF%A1%E6%81%AF%EF%BC%88%E8%AF%A6%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%B9%B6%E6%AD%A3%E5%B8%B8%E8%BF%90%E8%A1%8C%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后，用户（如henrik）将收到容器就绪的通知。随后，用户可使用docker或rkt拉取相应容器。

3. 开发容器

3.1 如何构建BioContainer？

构建容器有两种方式：

• 前往目标软件的GitHub仓库（包含构建 recipe），克隆后在本地构建。
• 使用Docker守护进程搜索现成的容器化软件版本。

中央仓库中列出了带有Docker recipe的软件，可在其中获取更多使用信息。

3.2 开发所需环境

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

3.3 如何创建基于Docker的BioContainer？

需创建Dockerfile，这是指导守护进程设置适当OS、下载、管理、安装软件并提供访问权限的简单脚本。可查看Docker文档获取更多信息。容器就绪后，可联系项目团队，通过自动化构建系统将容器发布给社区。

3.4 如何创建基于rkt的BioContainer？

需创建rkt容器 recipe，指导守护进程设置适当OS、下载、管理、安装软件并提供访问权限。可查看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%EF%BC%8C%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%AE%B9%E5%99%A8%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