Skip to main content

Diploid chromatin conformation capture analysis

Project description

Dip-C

Diploid Chromatin Conformation Capture — reconstruct 3D diploid genomes from single cells.

Installation

Method When to use Install time
conda + pip (recommended) Works everywhere; best for HPC clusters and older Linux ~1 minute
pip only Modern systems: macOS, Ubuntu 20.04+, RHEL 8+ ~15 seconds
pip only (source build) Older Linux (e.g. CentOS/RHEL 7, Stanford Sherlock); not recommended — use conda + pip instead 15–30 minutes

Recommended installation (conda + pip)

The easiest way to ensure that the installation will work on your system, regardless of the age of its software, is to create a conda environment and pre-install the compiled dependencies, then install Dip-C with pip:

conda create -n dipc python=3.11
conda activate dipc
conda install -c conda-forge -c bioconda numpy scipy pysam
pip install run-dipc

Note: If you see Run 'conda init' before 'conda activate' (common on HPC clusters), run this first:

source $(conda info --base)/etc/profile.d/conda.sh

Verify the installation:

dip-c --help

Alternative: pip-only install

On modern systems (macOS, Ubuntu 20.04+, RHEL 8+), pip can install everything directly. This is worth trying, but if it fails for any reason we suggest using the above conda + pip installation method:

pip install run-dipc

Why does pip fail on older Linux? (optional reading): If pip failed, use the conda + pip method above. Older systems like CentOS/RHEL 7 have an old C library (glibc < 2.28), so prebuilt packages for NumPy, SciPy, and pysam are not available. Pip falls back to compiling them from source, which takes 15–30 minutes and requires a C++17-capable compiler. If that build also fails with C++ Compiler does not support -std=c++17, the system's C++ compiler is too old. You can install a newer one with:

conda install -c conda-forge gcc_linux-64 gxx_linux-64

But the simplest path is to skip all of this and use the recommended conda + pip installation above.

Upgrading

If you already have Dip-C installed and want to update to the latest version:

pip install --upgrade run-dipc

Usage

dip-c <command> [options]

Run dip-c with no arguments to see all available commands.

Documentation

Full documentation, workflows, and file format specifications are available on GitHub:

https://github.com/tanlongzhi/dip-c

Citations

Please cite the original Dip-C paper:

Tan, Longzhi*; Xing, Dong*; Chang, Chi-Han; Li, Heng; Xie, X. Sunney "Three-dimensional genome structures of single diploid human cells," Science 361, 924-928 (2018). DOI:10.1126/science.aat5641

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

run_dipc-1.9.10.tar.gz (39.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

run_dipc-1.9.10-py3-none-any.whl (12.2 MB view details)

Uploaded Python 3

File details

Details for the file run_dipc-1.9.10.tar.gz.

File metadata

  • Download URL: run_dipc-1.9.10.tar.gz
  • Upload date:
  • Size: 39.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for run_dipc-1.9.10.tar.gz
Algorithm Hash digest
SHA256 ddb402b00980cdd09c9a0be6a833eaa403fca32aaac0fbaff4f86bec9c618861
MD5 e50aa06f7fa2043d42d82fa41edf5b1f
BLAKE2b-256 0a427b408175995f9b68d244a4d4c59722e9a4f5acd64070aef505916ba9b9f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for run_dipc-1.9.10.tar.gz:

Publisher: publish.yml on tanlongzhi/dip-c

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file run_dipc-1.9.10-py3-none-any.whl.

File metadata

  • Download URL: run_dipc-1.9.10-py3-none-any.whl
  • Upload date:
  • Size: 12.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for run_dipc-1.9.10-py3-none-any.whl
Algorithm Hash digest
SHA256 27bd8a882e8008c3521f99911f8541c53e80d09ae70bdf910e845f7642aa3a8c
MD5 f1885469fd01835692140c7d38141b20
BLAKE2b-256 aff76afbdeab67de912460ffbf7d64a02d53e91760e144ffff2f8dde30ee894d

See more details on using hashes here.

Provenance

The following attestation bundles were made for run_dipc-1.9.10-py3-none-any.whl:

Publisher: publish.yml on tanlongzhi/dip-c

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page