biocontainers/proteinprophet

BioContainers 镜像文档

1. 概述和主要用途

BioContainers项目旨在通过Docker或rkt等容器技术解决生物信息学软件的开发与分发问题。作为社区驱动项目，它提供基础设施和指南，用于创建、管理和分发生物信息学容器，特别关注蛋白质组学、基因组学、转录组学和代谢组学等组学领域。已实现的容器可促进软件和算法的使用与可重复性，能集成到全面的生物信息学pipeline中，适用于本地桌面、云环境或HPC集群等架构。

2. 核心功能和特性

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

3. 使用场景和适用范围

适用于需要生物信息学软件进行数据分析的研究人员、开发人员和机构，尤其适合：

• 蛋白质组学、基因组学、转录组学、代谢组学等组学领域的数据分析。
• 快速部署生物信息学工具，避免复杂依赖安装。
• 构建可重复的生物信息学pipeline，确保结果一致性。
• 在本地桌面、云环境或HPC集群中部署运行生物信息学软件。

4. 使用方法和配置说明

4.1 容器获取

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

4.2 基本使用步骤

4.2.1 Docker容器使用

1. 安装Docker引擎（参考：https://docs.docker.com/engine/install/%EF%BC%89%E3%80%82
2. 拉取容器：

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

   注：未指定版本标签时默认拉取latest版本。
3. 运行容器：

   bash
   docker run --rm docker.xuanyuan.run/biodckr/[软件名称]:[版本标签] [命令]
   

   --rm选项表示容器退出后自动删除，[命令]为容器内软件的具体执行命令。

4.2.2 rkt容器使用

1. 安装rkt（参考：https://github.com/coreos/rkt/blob/master/Documentation/getting-started-guide.md%EF%BC%89%E3%80%82
2. 获取容器：

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

3. 运行容器：

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

4.3 容器请求流程

用户可通过在sandbox仓库（http://github.com/BioContainers/sandbox/issues%EF%BC%89%E6%8F%90%E4%BA%A4issue%E8%AF%B7%E6%B1%82%E5%AE%B9%E5%99%A8%E3%80%82issue%E9%9C%80%E5%8C%85%E5%90%AB%EF%BC%9A

• 软件名称
• 代码或二进制文件URL
• 软件相关信息（详见规范：http://github.com/BioContainers/container-specs.md%EF%BC%89

容器部署完成后，issue将由开发者或贡献者关闭。

5. 容器开发指南

5.1 开发环境要求

• Linux操作系统
• Docker或rkt守护进程
• 待容器化的软件

5.2 构建容器的两种方式

1. 克隆包含软件recipe的GitHub仓库，在本地构建。
2. 通过Docker/rkt守护进程搜索现成的容器化软件版本。

5.3 创建Docker-based BioContainer

1. 编写Dockerfile，定义操作系统、软件下载、安装和访问方式（参考Docker文档：https://docs.docker.com/reference/builder/%EF%BC%89%E3%80%82
2. 构建容器：

   bash
   docker build -t biodckr/[软件名称]:[版本标签] .
   

3. 联系BioContainers团队，通过自动化构建系统发布容器。

5.4 创建rkt-based BioContainer

1. 编写rkt容器recipe，定义操作系统、软件下载、安装和访问方式（参考rkt文档：https://github.com/coreos/rkt/blob/master/Documentation/getting-started-guide.md%EF%BC%89%E3%80%82
2. 构建容器并联系团队发布。

6. 支持与参与

BioContainers是社区驱动项目，欢迎通过以下方式参与：

• 浏览容器列表：https://github.com/BioContainers/containers
• 提出软件或功能建议
• 参与社区讨论，反馈问题或需求

7. 相关链接

• 网页：[***]
• 项目定义：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
• ：

8. 许可证

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