StripePy recognizes architectural stripes in 3C and Hi-C contact maps using geometric reasoning
Project description
StripePy
| Paper |
|
| Downloads |
|
| Documentation |
|
| CI |
|
| 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,.cooland.mcool; outputs to.hdf5andBEDPE. - 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.hdf5file - link.stripepy view: take theresult.hdf5file generated bystripepy calland extract stripes in BEDPE format - link.stripepy plot: generate various kinds of plots to inspect the stripes identified bystripepy call- link.
For a quick introduction to the tool, refer to the Quickstart section in the documentation.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file stripepy_hic-1.2.0.tar.gz.
File metadata
- Download URL: stripepy_hic-1.2.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aea1fe2d25803aafb2dffc7f71e471f9be53123bdd255f72c47960c6ccfc6135
|
|
| MD5 |
a2684b565247f19344b3164331a08ff5
|
|
| BLAKE2b-256 |
8a5e5c9a948c5a8ce5ac943268ccc262cdbef020e594c971ac0cd44dedb97b8a
|
Provenance
The following attestation bundles were made for stripepy_hic-1.2.0.tar.gz:
Publisher:
build-package.yml on paulsengroup/StripePy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
stripepy_hic-1.2.0.tar.gz -
Subject digest:
aea1fe2d25803aafb2dffc7f71e471f9be53123bdd255f72c47960c6ccfc6135 - Sigstore transparency entry: 529201603
- Sigstore integration time:
-
Permalink:
paulsengroup/StripePy@07426cbc23edfa4b34d2129a6d83dd4bf48fa44f -
Branch / Tag:
refs/tags/v1.2.0 - Owner: https://github.com/paulsengroup
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-package.yml@07426cbc23edfa4b34d2129a6d83dd4bf48fa44f -
Trigger Event:
release
-
Statement type:
File details
Details for the file stripepy_hic-1.2.0-py3-none-any.whl.
File metadata
- Download URL: stripepy_hic-1.2.0-py3-none-any.whl
- Upload date:
- Size: 95.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8749a7719d5561ede2c03047d73faa19c5a76b0273775d76ef1ef766ccf5bfba
|
|
| MD5 |
6e7b3b573c9600b40d31a54af7a411b3
|
|
| BLAKE2b-256 |
b22c1c283a9af4fdf308eb2b5bf5f1902f82098fccd5e246fa9501d73be4d852
|
Provenance
The following attestation bundles were made for stripepy_hic-1.2.0-py3-none-any.whl:
Publisher:
build-package.yml on paulsengroup/StripePy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
stripepy_hic-1.2.0-py3-none-any.whl -
Subject digest:
8749a7719d5561ede2c03047d73faa19c5a76b0273775d76ef1ef766ccf5bfba - Sigstore transparency entry: 529201607
- Sigstore integration time:
-
Permalink:
paulsengroup/StripePy@07426cbc23edfa4b34d2129a6d83dd4bf48fa44f -
Branch / Tag:
refs/tags/v1.2.0 - Owner: https://github.com/paulsengroup
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-package.yml@07426cbc23edfa4b34d2129a6d83dd4bf48fa44f -
Trigger Event:
release
-
Statement type: