Sparse binary format for genomic interaction matrices
Project description
Cooler
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 at
ftp://cooler.csail.mit.edu/coolers. - 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
Requirements:
- Python 2.7/3.4+
- libhdf5 and Python packages
numpy,scipy,pandas,h5py. We highly recommend using thecondapackage manager to install scientific packages like these. To get it, you can either install the full Anaconda Python distribution or just the standalone conda package manager.
See the docs for more information.
NOTE: Python 2.7 support will sunset with cooler 0.8.
Contributing
Interested in contributing to cooler? That's great! To get started, check out the contributing guide.
Citing
Abdennur, N., and Mirny, L. (2019). Cooler: scalable storage for Hi-C data and other genomically labeled arrays. Bioinformatics. doi: 10.1093/bioinformatics/btz540.
@article{Cooler2019,
author = {Abdennur, Nezar and Mirny, Leonid A},
title = "{Cooler: scalable storage for Hi-C data and other genomically labeled arrays}",
journal = {Bioinformatics},
year = {2019},
month = {07},
doi = {10.1093/bioinformatics/btz540},
url = {https://doi.org/10.1093/bioinformatics/btz540},
}
License
BSD (3 Clause)
Related projects
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.8.8.tar.gz.
File metadata
- Download URL: cooler-0.8.8.tar.gz
- Upload date:
- Size: 9.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56608e68b88b141f7ec8fcacb8c610aded571fb180c03aa3b187cb5f28a3ea02 |
|
| MD5 | 8299ee70d1c3f615723326fb1b415d94 |
|
| BLAKE2b-256 | 963a9a7c77961f754b4ce2c5cbde56c2d08e9330511faa1028d20953d9b59c2f |
File details
Details for the file cooler-0.8.8-py2.py3-none-any.whl.
File metadata
- Download URL: cooler-0.8.8-py2.py3-none-any.whl
- Upload date:
- Size: 98.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1.post20200604 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | da2da77e08af0eddc8475bccc5a24caf55307bf25a3bfbca95f6429bbd197237 |
|
| MD5 | 9495cd0f4febc4d45697c7ba2eb0e5fc |
|
| BLAKE2b-256 | 0c1149d8aefe37abecc48d9e97b3ae3b20d1125a72209ad6a3c2135f232b8765 |
