Hi-C analysis tools by Python3
Project description
CustardPy: Docker image for 3D genome analysis
Major Release! (version 1)
This repository contains
- Source code of CustardPy (PyPI),
- Dockerfile of CustardPy Docker image,
- Full Manual, and
- Tutorial data of Hi-C and Micro-C analysis using demo data.
0. Changelog
See Changelog
1. Installation
Docker image is available at DockerHub.
1.1 Docker
To use docker command, type:
# pull docker image
docker pull rnakato/custardpy
# container login
docker run --rm -it rnakato/custardpy /bin/bash
# execute a command
docker run --rm -it -v (your directory):/opt/work rnakato/custardpy <command>
When calling loops using Juicer HICCUPS, suppy --gpus all
option to allow GPU computation (GPU card needed):
docker run --gpus all -it --rm -it -v (your directory):/opt/work rnakato/custardpy call_HiCCUPS.sh
1.2 Singularity
Singularity can also be used to execute the docker image:
# build image
singularity build custardpy.sif docker://rnakato/custardpy
# execute a command
singularity exec custardpy.sif <command>
Singularity mounts the current directory automatically. If you access the files in the other directory, please mount by --bind
option, for instance:
singularity exec --bind /work custardpy.sif <command>
This command mounts /work
directory.
When calling loops using Juicer HICCUPS, suppy --nv
option to allow GPU computation (GPU card needed):
singularity exec --bind /work custardpy.sif call_HiCCUPS.sh
2. Quickstart
# download Churros/tutorial directory
git clone https://github.com/rnakato/CustardPy.git
cd CustardPy/tutorial/Hi-C/
# download fastq and genome data and make index
bash 00_getdata.sh
# Execute Juicer pipeline
bash QuickStart_juicer.sh
3. Usage
See https://custardpy.readthedocs.io for the detailed Manual.
4. Build Docker image from Dockerfile
First clone and move to the repository
git clone https://github.com/rnakato/CustardPy.git
cd CustardPy/Docker
Then type:
docker build -f Dokerfile.<version> -t <account>/custardpy_juicer .
6. Reference
- 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
7. Contact
Ryuichiro Nakato: rnakato AT iqb.u-tokyo.ac.jp
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for custardpy-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b7a872830973e2eaacb6444814e6bde4de10f9e32182611e72c774ddc06a844 |
|
MD5 | 8a4515a68df1db95dc5a8aa353a58f35 |
|
BLAKE2b-256 | 2c4605b3197da6878233355a03175199c1b8f888274c91d83abb5eb14f9cad37 |