biocontainers/abyss

BioContainers 文档

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

最新的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
• ****：

许可证

Apache 2

目录

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. 如何构建BioContainer
   3.2. 开发所需条件
   3.3. 如何创建基于Docker的BioContainer
   3.4. 如何创建基于rkt的BioContainer
4. 支持
   4.1 参与方式

1. 基本信息

1.1. 什么是BioContainers？

BioContainers项目源于使用Docker或rkt等基于容器的技术来处理生物信息学软件的想法。拥有一个可控制的通用环境来运行软件，有助于解决当前软件开发和分发过程中的一些问题。BioContainers是一个社区驱动的项目，提供基础设施和基本指南，用于创建、管理和分发生物信息学容器，特别关注组学领域，如蛋白质组学、基因组学、转录组学和代谢组学。已在BioContainers中实现的主要容器（https://github.com/BioContainers/containers%EF%BC%89%E5%B7%B2%E8%AF%A6%E7%BB%86%E8%AE%A8%E8%AE%BA%EF%BC%8C%E5%8C%85%E6%8B%AC%E4%BD%BF%E7%94%A8BioContainers%E7%9A%84%E7%A4%BA%E4%BE%8B%E3%80%82
当前可用的BioContainers容器促进了软件和算法的使用及重现性。它们可以集成到更全面的生物信息学管道和不同架构（本地桌面、云环境或HPC集群）中。我们还提供了创建新容器以及如何为BioContainers项目做出贡献的指南和规范。

1.2. 目标

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

2. 容器

2.1. 什么是容器？

容器基于现有操作系统构建。它们与虚拟机的不同之处在于，容器内部没有完整的客户操作系统，而是使用优化的系统库，并利用主机操作系统的内存管理和进程控制。容器通常围绕特定软件构建，通过实例化镜像可以使其可执行。

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

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

大多数时候，进行生物信息学分析时，需要安装和配置多个生物信息学工具和软件。此过程可能需要数小时，并需要大量工作，包括安装多个依赖项和工具。BioContainers提供现成可用的软件包和工具，可以轻松部署并在本地机器、HPC和云架构中使用。

2.3. 如何使用BioContainer

BioContainers在两个主要 registry 中列出：

• 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%E5%8F%AF%E4%BD%BF%E7%94%A8Docker%E5%9F%BA%E7%A1%80%E8%AE%BE%E6%96%BD%E3%80%82
• QUAY Hub：基于Docker和rkt的容器，可使用rkt基础设施。

有关如何使用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%E4%B8%AD%E5%88%9B%E5%BB%BAissue%E6%9D%A5%E8%AF%B7%E6%B1%82%E5%AE%B9%E5%99%A8%EF%BC%88%E5%9C%A8%E5%89%8D%E9%9D%A2%E7%9A%84%E5%B7%A5%E4%BD%9C%E6%B5%81%E7%A8%8B%E4%B8%AD%EF%BC%8C%E8%BF%99%E6%98%AF%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%82%E8%AF%A5issue%E5%BA%94%E5%8C%85%E5%90%AB%E8%BD%AF%E4%BB%B6%E5%90%8D%E7%A7%B0%E3%80%81%E8%A6%81%E6%89%93%E5%8C%85%E7%9A%84%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%E4%BB%A5%E5%8F%8A%E6%9C%89%E5%85%B3%E8%BD%AF%E4%BB%B6%E7%9A%84%E4%BF%A1%E6%81%AFhttp://github.com/BioContainers/container-specs.md%E3%80%82%E5%BD%93%E5%AE%B9%E5%99%A8%E9%83%A8%E7%BD%B2%E5%B9%B6%E5%AE%8C%E5%85%A8%E5%8A%9F%E8%83%BD%E6%AD%A3%E5%B8%B8%E5%90%8E%EF%BC%8C%E8%AF%A5issue%E5%B0%86%E7%94%B1%E5%BC%80%E5%8F%91%E4%BA%BA%E5%91%98%E6%88%96BioContainers%E7%9A%84%E8%B4%A1%E7%8C%AE%E8%80%85%E5%85%B3%E9%97%AD%E3%80%82

2.4.2 使用容器

当容器部署完成且开发人员关闭GitHub上的issue后，用户（henrik）会收到容器已准备就绪的通知。然后，用户可以使用docker或rkt拉取或获取相应的容器。

3. 开发容器

3.1. 如何构建BioContainer

有两种构建容器的方法：

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

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

3.2. 开发所需条件

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

3.3. 如何创建基于Docker的BioContainer

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

有关更多信息，您可以查看Docker文档。

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

3.4. 如何创建基于rkt的BioContainer

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

有关更多信息，您可以查看https://github.com/coreos/rkt/blob/master/Documentation/getting-started-guide.md%E6%96%87%E6%A1%A3%E3%80%82

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

4. 支持

4.1. 参与方式

无论您是想将自己的软件作为容器提供给他人，还是只想在您的管道和分析中使用它们，或者只是提供意见，都非常欢迎。这是一个社区驱动的项目，意味着每个人都有发言权。

以下是一些基本思路：

• 浏览我们的容器列表
• 提出您自己的想法或软件
• 如果您认为缺少某些内容，请与他人互动。