This is the Hi-C pipeline from the Sequana project.
- Overview:
Hi-C pipeline to capture 3D chromatin interactions in a genome
- Input:
Paired FastQ files and a reference genome in FASTA format
- Output:
Cooler contact matrices, Hi-C QC reports, and a MultiQC summary
- Status:
Production
- Citation:
Cokelaer et al, (2017), ‘Sequana’: a Set of Snakemake NGS pipelines, Journal of Open Source Software, 2(16), 352, JOSS DOI https://doi:10.21105/joss.00352
Installation
If you already have all requirements, install the package with pip:
pip install sequana_hic --upgrade
You will need third-party tools (see Requirements below). Use apptainer images to avoid installing them locally.
Usage
Set up the pipeline directory with your input data and reference:
sequana_hic --input-directory DATAPATH --reference-file genome.fa sequana_hic --input-directory DATAPATH --reference-file genome.fa --aligner-choice bwa_split
This creates a hic/ directory containing the pipeline and configuration file. Execute the pipeline locally:
cd hic sh hic.sh
See .sequana/profile/config.yaml to tune Snakemake behaviour (cores, cluster settings, etc.).
Usage with apptainer
With Apptainer, initiate the working directory as follows:
sequana_hic --input-directory DATAPATH --reference-file genome.fa --use-apptainer
Images can be stored in a shared location:
sequana_hic --input-directory DATAPATH --reference-file genome.fa --use-apptainer --apptainer-prefix ~/.sequana/apptainers
then:
cd hic sh hic.sh
If running Snakemake manually, add apptainer options:
snakemake -s hic.rules --cores 4 --use-apptainer --apptainer-prefix ~/.sequana/apptainers --apptainer-args "-B /home:/home"
By default the home directory is already bound. Additional paths can be set via:
export APPTAINER_BINDPATH="-B /pasteur"
Requirements
This pipeline requires the following executables (install via bioconda/conda):
bwa — short-read aligner (default mapper)
samtools — BAM/SAM manipulation
pairtools — processing of Hi-C read pairs
cooler — storage and analysis of Hi-C contact matrices
qc3c — Hi-C quality control
fastqc — raw read quality control
multiqc — aggregate QC reports
Optional:
chromap — fast Hi-C aligner (experimental, use --aligner-choice chromap)
seqkit — split FastQ files (required for --aligner-choice bwa_split)
Pipeline description
FastQC — quality control on raw reads
Reference indexing — BWA index build from the provided FASTA reference
Alignment — BWA-MEM alignment with Hi-C-specific options (-5SP), producing sorted BAM files
Pairtools — parse alignments into Hi-C contact pairs, sort, deduplicate, and split
Cooler — load pairs into a contact matrix and generate multi-resolution .mcool file
qc3C — Hi-C library quality assessment (ligation efficiency, distance distribution)
Visualisation — contact matrix PNG at 5 kb resolution
MultiQC — aggregated QC report
Changelog
Version |
Description |
|---|---|
0.2.0 |
Production release. |
0.1.0 |
Migration to modern sequana_pipetools framework (get_shell/get_run, schema validation, apptainer support, Python 3.10+). |
0.0.1 |
First release. |
Contribute & Code of Conduct
To contribute to this project, please take a look at the Contributing Guidelines first. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
Metadata
Release files for sequana-hic 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sequana_hic-0.2.0.tar.gz | 136.0 kB | Without provenance | Details for sequana_hic-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sequana_hic-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for sequana_hic-0.2.0-py3-none-any.whl |
Total release size: 272.6 kB
Release files / sequana_hic-0.2.0.tar.gz
| Download URL | sequana_hic-0.2.0.tar.gz |
|---|---|
| Size | 136.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1dbb7f80d83d834453843549299de23202d7971ddb2f16afd96b24c6ac54d709
|
|
BLAKE2b-256 checksum How to use checksums |
9ad62afbb1eb438bc89e8201a42bbb81a912d27862a1d4ee83b3d5950acbcefa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.11.15 Linux/6.14.5-100.fc40.x86_64
|
Release files / sequana_hic-0.2.0-py3-none-any.whl
| Download URL | sequana_hic-0.2.0-py3-none-any.whl |
|---|---|
| Size | 136.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f37e9ee8774d9acd76ef8106ad7c1b4e6856c56e3828ffe6ed287175c7bfe1c7
|
|
BLAKE2b-256 checksum How to use checksums |
087244967477372482ace0940f80ff44a7dd1290a33419210a1d0ba10b56a53a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.11.15 Linux/6.14.5-100.fc40.x86_64
|
Security for sequana-hic 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.