Cooler
| Latest Release |
|
| License |
|
| Build Status |
|
| Pre-commit Status |
|
| Docs Status |
|
| Coverage |
|
| Downloads |
|
| Citation |
|
| Community |
|
A cool place to store your Hi-C
Cooler is a support library for a sparse, compressed, binary persistent storage format, also called cooler, used to store genomic interaction data, such as Hi-C contact matrices.
The cooler file format is an implementation of a genomic matrix data model using HDF5 as the container format. The cooler package includes a suite of command line tools and a Python API to facilitate creating, querying and manipulating cooler files.
To get started:
- Install cooler
- Read the documentation and see the Jupyter Notebook walkthrough.
- cool files from published Hi-C data sets are available here or via s3 (bucket
s3://cooler01 --endpoint-url https://usgs2.osn.mghpcc.org --no-sign-request). - Many more multires (mcool) files are available on the 4DN data portal.
Installation
Install from PyPI using pip.
$ pip install cooler
If you are using conda, you can alternatively install cooler from the bioconda channel.
$ conda install -c conda-forge -c bioconda cooler
Citing
Abdennur, N., and Mirny, L.A. (2020). Cooler: scalable storage for Hi-C data and other genomically labeled arrays. Bioinformatics. doi: 10.1093/bioinformatics/btz540.
@article{cooler2020,
author = {Abdennur, Nezar and Mirny, Leonid A},
title = "{Cooler: scalable storage for Hi-C data and other genomically labeled arrays}",
journal={Bioinformatics},
volume={36},
number={1},
pages={311--316},
year={2020},
doi = {10.1093/bioinformatics/btz540},
url = {https://doi.org/10.1093/bioinformatics/btz540},
}
Contributing
Interested in contributing to cooler? That's great! To get started, check out the contributing guide.
Related projects
- See other Open2C tools to process Hi-C data (pairtools, distiller) and analyze Hi-C data (cooltools)!
- Visualize your cooler data with HiGlass!
- Check out this list of 3D genomics tools and papers, most of which accept cooler files.
Affiliations and Acknowledgements
- Cooler is an Affiliated Project of NumFOCUS.
- Cooler development has received support from the NIH 4D Nucleome Consortium.
- We are grateful for a storage allocation from NSF's ACCESS Cyberinfrastucture Open Storage Network to host example cooler data.
Release files for cooler 0.10.2
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 | |
|---|---|---|---|---|
| cooler-0.10.2.tar.gz | 11.1 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cooler-0.10.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.2 MB
Release files / cooler-0.10.2.tar.gz
| Download URL | cooler-0.10.2.tar.gz |
|---|---|
| Size | 11.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3780a2e69b2ec89882dfc2775de5d9b54ccb79569dc5f042b4851599388112dc
|
|
BLAKE2b-256 checksum How to use checksums |
5e481427493331ebcc63f48bf6bf78e6b54137e638621dadff6354f96a26f818
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / cooler-0.10.2-py3-none-any.whl
| Download URL | cooler-0.10.2-py3-none-any.whl |
|---|---|
| Size | 109.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4fd30a2981b4a7ab9d7c8074d9b985561902b9984f7bdff594d6fc40ed8cb505
|
|
BLAKE2b-256 checksum How to use checksums |
784b1a8da8799659aadf1449b2ad9d0cf0cfba3738dc4cb5b338d2c71606ff2c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Security for cooler 0.10.2
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.
