biocontainers/fastxtools

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%E4%B8%AD%E5%AE%9E%E7%8E%B0%E7%9A%84%E4%B8%BB%E8%A6%81%E5%AE%B9%E5%99%A8%E5%8C%85%E5%90%AB%E8%AF%A6%E7%BB%86%E8%AF%B4%E6%98%8E%E5%8F%8A%E4%BD%BF%E7%94%A8%E7%A4%BA%E4%BE%8B%E3%80%82%E5%BD%93%E5%89%8D%E5%8F%AF%E7%94%A8%E7%9A%84 BioContainers 容器简化了软件和算法的使用与重现，可集成到更全面的生物信息学管道中，并适用于不同架构（本地桌面、云环境或 HPC 集群）。项目还提供创建新容器及贡献的指南和规范。

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 中列出：

• https://hub.docker.com/u/biodckr/%EF%BC%9A%E5%9F%BA%E4%BA%8E Docker 的容器，可使用 Docker 基础设施。
• 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 中提交 issue 来请求容器（在上述工作流程中，这是用户 henrik 执行的第一步）。issue 应包含软件名称、待打包代码或二进制文件的 URL，以及软件相关信息（参见 http://github.com/BioContainers/container-specs.md%EF%BC%89%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%8F%AF%E7%94%A8%E5%90%8E%EF%BC%8C%E5%BC%80%E5%8F%91%E8%80%85%E6%88%96 BioContainers 贡献者将关闭该 issue。

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 获取更多信息。
容器就绪后，可联系项目团队，安排通过自动化构建系统将容器向社区开放。

4. 支持

4.1. 参与贡献

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

以下是一些参与方向：

• 浏览容器列表
• 提出自己的想法或软件建议
• 若认为有缺失内容，与他人交流