biocontainers/percolator

BioContainers 镜像文档

镜像概述和主要用途

BioContainers是一个社区驱动的项目，旨在通过Docker或rkt等容器技术，为生物信息学软件提供标准化的容器化解决方案。该项目专注于组学领域（如蛋白质组学、基因组学、转录组学和代谢组学），提供可控的软件运行环境，解决生物信息学软件在开发、分发和使用过程中的环境一致性问题。通过BioContainers，用户可轻松获取、部署和集成生物信息学工具，适用于本地桌面、云环境或HPC集群等多种架构。

核心功能和特性

• 标准化容器规范：提供基础规范和镜像，简化生物信息学软件的构建与部署，包含源代码和使用示例。
• 丰富的容器库：维护一系列现成可用的生物信息学工具容器（https://github.com/BioContainers/containers%EF%BC%89%EF%BC%8C%E6%94%AF%E6%8C%81%E7%9B%B4%E6%8E%A5%E9%9B%86%E6%88%90%E5%88%B0%E5%88%86%E6%9E%90%E6%B5%81%E7%A8%8B%E4%B8%AD%E3%80%82
• 多架构支持：容器可在本地桌面、云环境及HPC集群等多种架构中运行。
• 可重现性：通过指定容器版本，确保分析结果的一致性和可重现性。
• 社区协作：提供完整的开发、部署和测试基础设施，支持社区贡献和协作，包括持续集成（如Travis CI、Shippable）。

使用场景和适用范围

• 生物信息学分析：适用于蛋白质组学、基因组学、转录组学等组学领域的数据分析。
• 软件部署：简化生物信息学工具的安装和配置，减少依赖管理工作量。
• 流程集成：可集成到复杂的生物信息学流程中，支持自动化分析。
• 教学与科研：提供一致的软件环境，便于教学演示和科研结果重现。

详细使用方法和配置说明

容器获取与使用

BioContainers容器主要托管在两个 registry：

• Docker Hub：https://hub.docker.com/u/biodckr/%EF%BC%88%E5%9F%BA%E4%BA%8EDocker%E7%9A%84%E5%AE%B9%E5%99%A8%EF%BC%89
• QUAY Hub：https://quay.io/organization/biodckr%EF%BC%88%E6%94%AF%E6%8C%81Docker%E5%92%8Crkt%E7%9A%84%E5%AE%B9%E5%99%A8%EF%BC%89

使用Docker容器示例

1. 拉取容器：

   bash
   docker pull docker.xuanyuan.run/biodckr/[容器名称]:[版本标签]
   

   例如，拉取特定版本的BWA容器：

   bash
   docker pull docker.xuanyuan.run/biodckr/bwa:0.7.17
   

2. 运行容器：

   bash
   docker run --rm docker.xuanyuan.run/biodckr/bwa:0.7.17 bwa mem -h
   

   （--rm参数表示容器退出后自动删除）

使用rkt容器示例

1. 获取容器：

   bash
   rkt fetch quay.io/biodckr/[容器名称]:[版本标签]
   

2. 运行容器：

   bash
   rkt run quay.io/biodckr/[容器名称]:[版本标签] --exec [命令]
   

容器请求流程

若需特定软件的容器，可通过以下步骤请求：

1. 在 http://github.com/BioContainers/sandbox/issues 提交issue。
2. issue需包含：软件名称、代码或二进制文件URL、软件相关信息（参考http://github.com/BioContainers/container-specs.md%EF%BC%89%E3%80%82
3. 容器开发完成后，开发者会关闭issue，用户将收到通知。

容器开发指南

开发环境要求

• 安装Linux操作系统
• 安装Docker或rkt引擎
• 待容器化的生物信息学软件

创建Docker容器

1. 编写Dockerfile：Dockerfile是构建容器的配方文件，需指定基础镜像、软件下载、安装及配置步骤。参考https://docs.docker.com/reference/builder/%E3%80%82

2. 构建容器：

   bash
   docker build -t [容器名称]:[版本] .
   

3. 提交贡献：完成后可联系BioContainers团队，通过自动化构建系统将容器发布到公共registry。

创建rkt容器

1. 编写rkt配置文件：定义容器的基础OS、软件下载、安装及访问方式。参考https://github.com/coreos/rkt/blob/master/Documentation/getting-started-guide.md%E3%80%82

2. 构建与发布：构建完成后联系团队，通过自动化系统发布到公共registry。

支持与参与

社区参与方式

• 浏览容器列表：访问https://github.com/BioContainers/containers%E4%BA%86%E8%A7%A3%E5%8F%AF%E7%94%A8%E5%B7%A5%E5%85%B7%E3%80%82
• 提出需求：通过GitHub issue请求新容器或功能。
• 贡献代码：提交容器配方、改进文档或参与讨论。
• 交流互动：通过https://gitter.im/biocontainers/Lobby%E4%B8%8E%E7%A4%BE%E5%8C%BA%E4%BA%A4%E6%B5%81%E3%80%82

相关链接

• 官方网站：[***]
• 项目规范：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