beacon2ri/beacon_reference_implementation

Beacon参考实现Docker镜像使用指南

镜像概述

该Docker镜像提供Beacon参考实现（Beacon Reference Implementation），允许用户在容器化环境中快速部署和运行Beacon工具。通过Docker，用户无需手动配置复杂依赖，即可轻松使用Beacon的数据注释、命令执行及外部数据访问等功能。

核心功能

1. 容器化部署：一键拉取镜像并启动容器，简化环境配置流程。
2. 外部工具注入：支持注入snpEff等注释数据库及配套工具，确保Beacon功能完整性。
3. 命令执行：容器内直接运行Beacon命令，查看工具列表及使用说明。
4. 数据卷挂载：通过挂载外部目录，实现容器与主机文件系统的数据共享，方便访问外部数据。

使用场景

• 研究人员或开发者快速测试Beacon工具功能。
• 避免本地环境依赖冲突，采用容器化方式运行Beacon。
• 需要访问外部数据文件，通过卷挂载实现数据共享。

配置说明

1. 安装Docker

根据操作系统选择对应安装方式：

• MacOS：https://docs.docker.com/docker-for-mac/install/
• Windows：https://docs.docker.com/docker-for-windows/install/%EF%BC%88%E9%9D%9EPro%E7%89%88%E6%9C%AC%E5%8F%AF%E8%83%BD%E9%9C%80%E4%BD%BF%E7%94%A8Docker Toolbox）
• Linux：https://docs.docker.com/engine/installation/#supported-platforms

2. 验证Docker安装

打开终端执行以下命令验证Docker是否正常运行：

bash
docker --version

预期输出类似：Docker version 20.10.14, build a224086。

3. 拉取镜像

执行以下命令从Docker Hub拉取Beacon镜像：

bash
docker pull beacon2ri/beacon_reference_implementation:v2.0.0

（注：v2.0.0为版本标签，可替换为其他版本）

4. 启动容器

使用以下命令启动容器（后台模式）：

bash
docker run -tid --name beacon2-ri-tools beacon2ri/beacon_reference_implementation:v2.0.0

执行docker ps可查看运行中的容器。

5. 连接到容器

执行以下命令进入容器终端：

bash
docker exec -ti beacon2-ri-tools bash

成功进入后，终端提示符会变为类似root@a5b3750629a8:/usr/share/beacon-ri#。

6. 注入注释数据库

在容器内执行以下命令注入外部工具及数据库：

bash
bash /usr/share/beacon-ri/beacon2-ri-tools/BEACON/bin/deploy_external_tools.sh

（注：该过程需68GB磁盘空间，耗时较长）

7. 运行Beacon命令

在容器内执行以下命令查看Beacon工具列表：

bash
cd /usr/share/beacon-ri/beacon2-ri-tools
./beacon -h

预期输出Beacon工具的使用说明及功能列表。

8. 挂载外部数据卷

为访问主机数据，停止现有容器并重新启动（替换~/my_project为你的主机目录）：

1. 退出容器：exit
2. 停止并删除现有容器：

   bash
   docker stop $(docker ps -aqf "name=beacon2-ri-tools")
   docker rm $(docker ps -aqf "name=beacon2-ri-tools")
   

3. 启动新容器并挂载卷：

   bash
   docker run -v ~/my_project:/usr/share/beacon-ri/beacon2-ri-tools/my_data -tid --name beacon2-ri-tools beacon2ri/beacon_reference_implementation:v2.0.0
   

挂载后，容器内/usr/share/beacon-ri/beacon2-ri-tools/my_data目录与主机~/my_project目录共享数据。