Sparse binary format for genomic interaction matrices.
Project description
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 history Release notifications | RSS feed
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
File details
Details for the file cooler-0.10.1.tar.gz.
File metadata
- Download URL: cooler-0.10.1.tar.gz
- Upload date:
- Size: 11.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 014e4fe5ab9785670f7773cc95bf9319fae25df60b0bfba4052289d2d67c5bec |
|
| MD5 | 2f5fd3d5ad077fdd319a91645497b03f |
|
| BLAKE2b-256 | ba0e37f8822a0bbca320cca4d83371930a30cc3e8c5401a660e9b937c9bba22c |
File details
Details for the file cooler-0.10.1-py3-none-any.whl.
File metadata
- Download URL: cooler-0.10.1-py3-none-any.whl
- Upload date:
- Size: 109.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d901469513b077b1584595027f73094bbda725daddd4f19866670031fabef895 |
|
| MD5 | ec558c25209da46328f8b370a28ebb30 |
|
| BLAKE2b-256 | 328ea54d04ff9e87cecac656e4db8018baa9f8797370c72a50a7f5bf080c4c35 |
