SAW安装和启动 - 华大时空

SAW软件操作手册

7.0

栏目辅助 7.1 7.0 6.1 6.0

版本说明

背景介绍

可下载资料

SAW安装和启动

SAW流程操作介绍

测试数据结果展示

附录和参考文献

SAW安装和启动

1. SAW镜像安装

SAW docker 镜像软件包已包含运行软件必须的依赖包，用户可通过 Docker Hub下载 SAW docker 镜像，以帮助用户在本地快速搭建 SAW 镜像，进行离线分析。请下载最新的软件并使用与其对应版本的手册。

Docker Hub链接：https://hub.docker.com/r/stomics/saw/tags

目前SAW的安装和运行支持Singularity和Docker两种方式 (如需安装Singularity，请自行安装或参考4 SAW GitHub)，以6.1版本为例使用教程如下：

1.1 利用Singularity安装SAW

*请注意将紫色高亮的入参替换为您的真实路径和数据。

第一步：使用singularity拉取镜像（2种方法）：

bash

$ singularity build SAW_v7.0.sif docker://stomics/saw:07.0.0 ## option 1

$ singularity build --sandbox SAW_v7.0/ docker://stomics/saw:07.0.0 ## option 2

非root用户，尤其是/home/目录下磁盘空间不够时，请尝试：

bash
$ export SINGULARITY_CACHEDIR=/path/to/build

$ singularity build --sandbox SAW_v7.0/ docker://stomics/saw:07.0.0

第二步：使用singularity运行镜像（3种方法）：

*注意！在运行singularity镜像时，所有涉及目录均需提前挂载。如：输入文件目录/path/to/data，参考基因组目录/path/to/genomeDir，输出结果目录/path/to/output。

bash
$ export SINGULARITY_BIND="/path/to/data,/path/to/genomeDir,/path/to/output"

方法一：启动容器并在容器中执行命令

bash
$ /path/to/SAW_v7.0.sif <application> ## option 1.1

$ singularity exec /path/to/SAW_v7.0.sif <application> ## option 1.2

方法二：启动容器并打开交互式终端，在容器中运行bash命令。需执行exit退出环境。

bash
$ /path/to/SAW_v7.0.sif /bin/bash ## option 2.1
Singularity>
Singularity> <shell-command>
Singularity> exit
$
$ singularity shell /path/to/SAW_v7.0.sif ## option 2.2
Singularity>
Singularity> <shell-command>
Singularity> exit
$
$ singularity shell SAW_v7.0 ## option 2.3 for sandbox
Singularity>
Singularity> <shell-command>
Singularity> exit
$

方法三：通过参数“-B 外部路径:容器内路径”挂载用户自定义目录至容器中，并在容器中执行命令。

bash
$ singularity shell -B /path/to/directory/on/the/host-machine:/path/to/directory/mounted/in/the/container /path/to/SAW_v7.0.sif
Singularity>
Singularity> <shell-command>
Singularity> exit
$

1.2 利用Docker安装SAW

第一步：使用docker拉取镜像：

bash
$ docker pull stomics/saw:07.0.0

第二步：交互式运行镜像：

bash
$ docker run -d -v /path/to/data:stomics/saw:07.0.0 /bin/sh -c "<shell-command>"

2. SAW GitHub

SAW GitHub：https://github.com/STOmics/SAW
用户可进入GitHub页面查看singularity的安装、参考基因组索引构建、以及SAW shell脚本。

*注意！请在运行SAW分析前构建索引。

82fbdb8c-55a4-4870-ac58-d6052a024562

3. SAW测试数据

测试数据可从SAW GitHub页面获取。测试结果可参考第三章测试数据结果展示，测试使用参考基因组版本为:

genome-build: GRCm38.p6
genome-version: GRCm38
genome-date: 2012-01
genome-build-accession: NCBI:GCA_000001635.8

4. SAW结果文件格式

SAW结果文件格式介绍参见《STOmics分析流程结果文件格式说明》。