biocontainers/progressivecactus

BioContainers 镜像文档

基本概述

1.1 什么是BioContainers？

BioContainers项目源于使用Docker或rkt等基于容器的技术来处理生物信息学软件的想法。拥有一个可控制的通用环境来运行软件，有助于解决软件开发和分发过程中的一些当前问题。BioContainers是一个社区驱动的项目，提供基础设施和基本指南，用于创建、管理和分发生物信息学容器，特别关注蛋白质组学、基因组学、转录组学和代谢组学等组学领域。已在BioContainers中实现的主要容器（https://github.com/BioContainers/containers）已详细讨论，包括如何使用BioContainers的示例。

当前可用的BioContainers容器促进了软件和算法的使用及可重复性。它们可以集成到更全面的生物信息学流程和不同架构（本地桌面、云环境或HPC集群）中。我们还提供了创建新容器以及如何为BioContainers项目做贡献的指南和规范。

1.2 目标与宗旨

• 提供基础规范和镜像，以便轻松构建和部署新的生物信息学/蛋白质组学软件，包括源代码和示例。
• 提供一系列可供生物信息学社区直接使用的容器（https://github.com/BioContainers/containers）。
• 定义一套指南和规范，以构建可与其他容器和生物信息学工具结合使用的标准化容器。
• 定义完整的基础设施，使用Travis Continuous Integration（[]）、Shippable（[]）或手动构建的解决方案等持续集成套件来开发、部署和测试新的生物信息学容器。
• 为生物信息学社区提供支持和帮助，为没有生物信息学支持的研究人员部署新容器。
• 提供关于如何通过定义、重用和报告特定容器版本来创建可重现流程的指南和帮助，这些版本将始终产生完全相同的结果，并且在容器历史中始终可用。
• 协调和整合开发人员和生物信息学家，以产生文档和软件开发的最佳实践。

容器

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基础设施。

有关如何使用BioContainers执行生物信息学分析的完整文档，请查看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将由开发者或BioContainers贡献者关闭。

2.4.2 使用BioContainer

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

开发容器

3.1 如何构建BioContainer？

有两种不同的构建容器的方法：

• 前往包含您所需软件配方的GitHub仓库，克隆它，然后在您的机器上自行构建。
• 使用docker守护进程搜索您所需的容器化软件的现成版本。

在中央仓库中有一系列带有docker配方的软件列表，您可以在那里找到有关如何使用它们的更多信息。

3.2 开发需要什么？

BioContainers基于Linux系统，因此您需要一台安装了Linux的计算机，还需要docker或rkt守护进程以及要容器化的软件。

3.3 如何创建基于Docker的BioContainer？

准备好所有内容后，您需要创建一个Dockerfile。Dockerfile是简单的配方，用于指导守护进程如何设置适当的操作系统以及如何下载、管理、安装软件并提供对软件的访问。

您可以查看https://docs.docker.com/reference/builder/文档获取更多信息。

容器准备就绪后，您可以与我们联系，以便我们做出适当安排，通过提供自动化构建系统使您的容器对社区中的每个人可用。

3.4 如何创建基于rkt的BioContainer？

准备好所有内容后，您需要创建rkt容器。rkt容器是简单的配方，用于指导守护进程如何设置适当的操作系统以及如何下载、管理、安装软件并提供对软件的访问。

您可以查看https://github.com/coreos/rkt/blob/master/Documentation/getting-started-guide.md文档获取更多信息。

容器准备就绪后，您可以与我们联系，以便我们做出适当安排，通过提供自动化构建系统使您的容器对社区中的每个人可用。

支持

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
• 电子邮件：***

许可证

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