1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
# Cooler
<a href="https://open2c.github.io/cooler"><img width="25%" src="https://github.com/open2c/cooler/raw/master/docs/cooler_logo.png" alt="Cooler"></a>
<table>
<tr>
<td>Latest Release</td>
<td>
<a href="https://pypi.org/project/cooler/">
<img src="https://img.shields.io/pypi/v/cooler?color=blue&label=PyPI%20package" alt="latest release pypi">
</a>
<a href="https://bioconda.github.io/recipes/cooler/README.html">
<img src="https://img.shields.io/conda/vn/bioconda/cooler?color=blue" alt="latest release bioconda">
</a>
</td>
</tr>
<tr>
<td>License</td>
<td>
<a href="https://github.com/open2c/cooler/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-BSD-green" alt="license">
<!-- <img src="https://img.shields.io/pypi/l/cooler.svg" alt="license"> -->
</a>
</td>
</tr>
<tr>
<td>Build Status</td>
<td>
<a href="https://github.com/open2c/cooler/blob/master/.github/workflows/ci.yml">
<img src="https://github.com/open2c/cooler/actions/workflows/ci.yml/badge.svg" alt="build status">
</a>
</td>
</tr>
<tr>
<td>Pre-commit Status</td>
<td>
<a href="https://results.pre-commit.ci/repo/github/49553222">
<img src="https://results.pre-commit.ci/badge/github/open2c/cooler/master.svg" alt="pre-commit status" />
</a>
</td>
</tr>
<tr>
<td>Docs Status</td>
<td>
<a href="http://cooler.readthedocs.org/en/latest/">
<img src="https://readthedocs.org/projects/cooler/badge/?version=latest">
</a>
</td>
</tr>
<tr>
<td>Coverage</td>
<td>
<a href="https://codecov.io/gh/open2c/cooler">
<img src="https://codecov.io/gh/open2c/cooler/branch/master/graph/badge.svg" alt="coverage">
</a>
</td>
</tr>
<tr>
<td>Downloads</td>
<td>
<a href="https://pypi.org/project/cooler">
<img src="https://static.pepy.tech/personalized-badge/cooler?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads" alt="pypi downloads">
</a>
<a href="http://bioconda.github.io/recipes/cooler/README.html">
<img src="https://img.shields.io/conda/dn/bioconda/cooler.svg?style=flat&label=Bioconda downloads" alt="bioconda downloads">
</a>
</td>
</tr>
<tr>
<td>Citation</td>
<td>
<a href="https://doi.org/10.1093/bioinformatics/btz540">
<img src="https://img.shields.io/badge/DOI-10.1093%2Fbioinformatics%2Fbtz540-blue" alt="paper doi">
</a>
<a href="https://zenodo.org/badge/latestdoi/49553222">
<img src="https://zenodo.org/badge/49553222.svg" alt="zenodo doi">
</a>
</td>
</tr>
<tr>
<td>Community</td>
<td>
<a href="https://bit.ly/open2c-slack">
<img src="https://img.shields.io/badge/chat-slack-%233F0F3F?logo=slack" alt="slack">
</a>
<a href="https://www.numfocus.org/">
<img src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A" alt="numfocus">
</a>
</td>
</tr>
</table>
## A cool place to store your Hi-C
Cooler is a support library for a **sparse, compressed, binary** persistent storage [format](http://cooler.readthedocs.io/en/latest/schema.html), 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](https://en.wikipedia.org/wiki/Hierarchical_Data_Format) as the container format. The `cooler` package includes a suite of [command line tools](http://cooler.readthedocs.io/en/latest/cli.html) and a [Python API](http://cooler.readthedocs.io/en/latest/api.html) to facilitate creating, querying and manipulating cooler files.
To get started:
- [Install](#Installation) cooler
- Read the [documentation](http://cooler.readthedocs.org/en/stable/) and see the Jupyter Notebook [walkthrough](https://github.com/open2c/cooler-binder).
- _cool_ files from published Hi-C data sets are available [here](https://usgs2.osn.mghpcc.org/cooler01/index.html) 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](https://data.4dnucleome.org/visualization/index).
### Installation
Install from PyPI using pip.
```sh
$ pip install cooler
```
If you are using `conda`, you can alternatively install `cooler` from the [bioconda](https://bioconda.github.io/index.html) channel.
```sh
$ 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](https://doi.org/10.1093/bioinformatics/btz540).
```bibtex
@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](https://github.com/open2c/cooler/blob/master/CONTRIBUTING.md).
### Related projects
- See other Open2C tools to process Hi-C data ([pairtools](https://github.com/open2c/pairtools), [distiller](https://github.com/open2c/distiller-nf)) and analyze Hi-C data ([cooltools](https://github.com/open2c/cooltools))!
- Visualize your cooler data with [HiGlass](http://higlass.io)!
- Check out this list of [3D genomics tools and papers](https://github.com/mdozmorov/HiC_tools), most of which accept cooler files.
### Affiliations and Acknowledgements
* Cooler is an Affiliated Project of [NumFOCUS](https://www.numfocus.org/).
* Cooler development has received support from the NIH [4D Nucleome](https://www.4dnucleome.org/) Consortium.
* We are grateful for a storage allocation from NSF's [ACCESS Cyberinfrastucture](https://access-ci.org/) Open Storage Network to host example cooler data.
|
