rnakato/custardpy

CustardPy：用于3D基因组分析的Docker镜像

0. 更新日志

参见https://github.com/rnakato/CustardPy/blob/main/ChangeLog.md

1. 安装

1.1 Docker

使用Docker命令的方法如下：

bash
# 拉取Docker镜像
docker pull rnakato/custardpy

# 容器登录
docker run --rm -it rnakato/custardpy /bin/bash
# 执行命令
docker run --rm -it -v (你的目录):/opt/work rnakato/custardpy <命令>

使用Juicer HICCUPS调用loop时，需提供--gpus all选项以启用GPU计算（需GPU显卡）：

bash
docker run --gpus all -it --rm -it -v (你的目录):/opt/work rnakato/custardpy call_HiCCUPS.sh

• 用户:密码
  • ubuntu:ubuntu

1.2 Singularity

Singularity是使用CustardPy的另一种方式。使用以下命令可以构建CustardPy的singularity文件（.sif）：

bash
singularity build custardpy.sif docker://rnakato/custardpy

或者，你可以从我们的Dropbox下载CustardPy singularity镜像（我们使用singularity版本3.8.5）。

然后你可以使用以下命令运行CustardPy：

bash
singularity exec custardpy.sif <命令>

Singularity会自动挂载当前目录。如果你需要访问其他目录中的文件，请使用--bind选项，例如：

bash
singularity exec --bind /work custardpy.sif <命令>

此命令会挂载/work目录。

使用Juicer HICCUPS调用loop时，需提供--nv选项以启用GPU计算（需GPU显卡）：

bash
singularity exec --bind /work custardpy.sif call_HiCCUPS.sh

2. 快速开始

bash
# 下载Churros/tutorial目录
git clone https://github.com/rnakato/CustardPy.git
cd CustardPy/tutorial/Hi-C/

# 下载fastq和基因组数据并创建索引
bash 00_getdata.sh

# 执行Juicer流程
bash QuickStart_juicer.sh

3. 使用方法

参见详细手册获取详细使用方法。

4. 从Dockerfile构建Docker镜像

首先克隆并进入仓库：

bash
git clone https://github.com/rnakato/CustardPy.git
cd CustardPy/Docker

然后执行：

bash
docker build -f Dokerfile.<version> -t <account>/custardpy_juicer .

6. 参考文献

• Nakato R, Sakata T, Wang J, Nagai LAE, Nagaoka Y, Oba GM, Bando M, Shirahige K. Context-dependent perturbations in chromatin folding and the transcriptome by cohesin and related factors. Nature Communications, 2023. doi: 10.1038/s41467-023-41316-4