Skip to main content

StripePy recognizes architectural stripes in 3C and Hi-C contact maps using geometric reasoning

Project description

StripePy


Paper Bioinformatics 2025
Downloads Bioconda   PyPI   Zenodo
Documentation Documentation
CI Ubuntu CI Status   Build Dockerfile Status
License License

StripePy is a CLI application written in Python that recognizes architectural stripes found in the interaction matrix files generated by Chromosome Conformation Capture experiments, such as Hi-C and Micro-C.

StripePy is developed on Linux and macOS and is also tested on Windows. Installing StripePy is quick and easy using pip:

pip install 'stripepy-hic[all]'

For other installation options (conda, source, and Docker or Singularity/Apptainer), and details on ensuring StripePy is in your PATH, please refer to the official documentation.

Why Choose StripePy?

StripePy stands out with several key features that make it a fast and robust stripe caller:

  • Broad Format Support: Compatible with major formats: .hic, .cool and .mcool; outputs to .hdf5 and BEDPE.
  • User-Friendly: Designed with an intuitive command-line interface, making stripe analysis accessible even to less experienced users.
  • Stripe descriptors: Computes stripe width, height, and generates various statistics for post-processing, e.g., ranking and filtering.
  • Optimized performance: Outperforms other tools over diverse datasets and a simulated benchmark, StripeBench.
  • Exceptional speed & Low Memory: Significantly faster than existing tools (2x Chromosight, 66x Stripenn), with much lower memory usage.

Key Features

StripePy is organized into a few subcommands:

  • stripepy download: download a minified sample dataset suitable to quickly test StripePy - link.
  • stripepy call: run the stripe detection algorithm and store the identified stripes in a .hdf5 file - link.
  • stripepy view: take the result.hdf5 file generated by stripepy call and extract stripes in BEDPE format - link.
  • stripepy plot: generate various kinds of plots to inspect the stripes identified by stripepy call- link.

For a quick introduction to the tool, refer to the Quickstart section in the documentation.

Graphical Abstract

For more information on the subcommands, please run stripepy --help and refer to the documentation and the paper.

Getting help

For any issues regarding StripePy installation, walkthrough, and output interpretation please open a discussion on GitHub.

If you've found a bug or would like to suggest a new feature, please open a new issue instead.

Citing

If you use StripePy in your research, please cite the following publication:

Andrea Raffo, Roberto Rossini, Jonas Paulsen
StripePy: fast and robust characterization of architectural stripes
Bioinformatics, Volume 41, Issue 6, June 2025, btaf351
https://doi.org/10.1093/bioinformatics/btaf351

BibTex
@article{stripepy,
    author = {Raffo, Andrea and Rossini, Roberto and Paulsen, Jonas},
    title = {{StripePy: fast and robust characterization of architectural stripes}},
    journal = {Bioinformatics},
    volume = {41},
    number = {6},
    pages = {btaf351},
    year = {2025},
    month = {06},
    issn = {1367-4811},
    doi = {10.1093/bioinformatics/btaf351},
    url = {https://doi.org/10.1093/bioinformatics/btaf351},
    eprint = {https://academic.oup.com/bioinformatics/article-pdf/41/6/btaf351/63484367/btaf351.pdf},
}

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

stripepy_hic-1.3.0.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

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

stripepy_hic-1.3.0-py3-none-any.whl (96.4 kB view details)

Uploaded Python 3

File details

Details for the file stripepy_hic-1.3.0.tar.gz.

File metadata

  • Download URL: stripepy_hic-1.3.0.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for stripepy_hic-1.3.0.tar.gz
Algorithm Hash digest
SHA256 8d1233e9a25a94427d15306358154ba0ccbd047a398981d3da8ab81d43149d25
MD5 145f6af7f2fbd2f4ae150a91c4c80941
BLAKE2b-256 b5079c9bf095804218167772a8af25607399d155b44e4f64cf5087c7a27df75b

See more details on using hashes here.

Provenance

The following attestation bundles were made for stripepy_hic-1.3.0.tar.gz:

Publisher: build-package.yml on paulsengroup/StripePy

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

File details

Details for the file stripepy_hic-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: stripepy_hic-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 96.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for stripepy_hic-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7f4d693b547348e15cb3ec5edbcd40a3a15e08393d4cfb714b0e33853be7f82
MD5 1c975133d346f545ffe3d9976f7089cb
BLAKE2b-256 0f00e9e22ecec20d3684083abdba5d07f6fd4b0f2a335e34ae38bc360c143669

See more details on using hashes here.

Provenance

The following attestation bundles were made for stripepy_hic-1.3.0-py3-none-any.whl:

Publisher: build-package.yml on paulsengroup/StripePy

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