# 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "cooler",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Open2C <open.chromosome.collective@gmail.com>",
"keywords": "Hi-C, bioinformatics, contact, format, genomics, hdf5, matrix, sparse",
"author": null,
"author_email": "Nezar Abdennur <nabdennur@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5e/48/1427493331ebcc63f48bf6bf78e6b54137e638621dadff6354f96a26f818/cooler-0.10.2.tar.gz",
"platform": null,
"description": "# Cooler\n\n<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>\n\n<table>\n <tr>\n <td>Latest Release</td>\n <td>\n <a href=\"https://pypi.org/project/cooler/\">\n <img src=\"https://img.shields.io/pypi/v/cooler?color=blue&label=PyPI%20package\" alt=\"latest release pypi\">\n </a>\n <a href=\"https://bioconda.github.io/recipes/cooler/README.html\">\n <img src=\"https://img.shields.io/conda/vn/bioconda/cooler?color=blue\" alt=\"latest release bioconda\">\n </a>\n </td>\n </tr>\n <tr>\n <td>License</td>\n <td>\n <a href=\"https://github.com/open2c/cooler/blob/master/LICENSE\">\n <img src=\"https://img.shields.io/badge/license-BSD-green\" alt=\"license\">\n <!-- <img src=\"https://img.shields.io/pypi/l/cooler.svg\" alt=\"license\"> -->\n </a>\n </td>\n </tr>\n <tr>\n <td>Build Status</td>\n <td>\n <a href=\"https://github.com/open2c/cooler/blob/master/.github/workflows/ci.yml\">\n <img src=\"https://github.com/open2c/cooler/actions/workflows/ci.yml/badge.svg\" alt=\"build status\">\n </a>\n </td>\n </tr>\n <tr>\n <td>Pre-commit Status</td>\n <td>\n <a href=\"https://results.pre-commit.ci/repo/github/49553222\">\n <img src=\"https://results.pre-commit.ci/badge/github/open2c/cooler/master.svg\" alt=\"pre-commit status\" />\n </a>\n </td>\n </tr>\n <tr>\n <td>Docs Status</td>\n <td>\n <a href=\"http://cooler.readthedocs.org/en/latest/\">\n <img src=\"https://readthedocs.org/projects/cooler/badge/?version=latest\">\n </a>\n </td>\n </tr>\n <tr>\n <td>Coverage</td>\n <td>\n <a href=\"https://codecov.io/gh/open2c/cooler\">\n <img src=\"https://codecov.io/gh/open2c/cooler/branch/master/graph/badge.svg\" alt=\"coverage\">\n </a>\n </td>\n </tr>\n <tr>\n <td>Downloads</td>\n <td>\n <a href=\"https://pypi.org/project/cooler\">\n <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\">\n </a>\n <a href=\"http://bioconda.github.io/recipes/cooler/README.html\">\n <img src=\"https://img.shields.io/conda/dn/bioconda/cooler.svg?style=flat&label=Bioconda downloads\" alt=\"bioconda downloads\">\n </a>\n </td>\n </tr>\n <tr>\n <td>Citation</td>\n <td>\n <a href=\"https://doi.org/10.1093/bioinformatics/btz540\">\n <img src=\"https://img.shields.io/badge/DOI-10.1093%2Fbioinformatics%2Fbtz540-blue\" alt=\"paper doi\">\n </a>\n <a href=\"https://zenodo.org/badge/latestdoi/49553222\">\n <img src=\"https://zenodo.org/badge/49553222.svg\" alt=\"zenodo doi\">\n </a>\n </td>\n </tr>\n <tr>\n <td>Community</td>\n <td>\n <a href=\"https://bit.ly/open2c-slack\">\n <img src=\"https://img.shields.io/badge/chat-slack-%233F0F3F?logo=slack\" alt=\"slack\">\n </a>\n <a href=\"https://www.numfocus.org/\">\n <img src=\"https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A\" alt=\"numfocus\">\n </a>\n </td>\n </tr>\n</table>\n\n## A cool place to store your Hi-C\n\nCooler 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.\n\nThe 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.\n\nTo get started:\n\n- [Install](#Installation) cooler\n- Read the [documentation](http://cooler.readthedocs.org/en/stable/) and see the Jupyter Notebook [walkthrough](https://github.com/open2c/cooler-binder).\n- _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`).\n- Many more multires (_mcool_) files are available on the [4DN data portal](https://data.4dnucleome.org/visualization/index).\n\n### Installation\n\nInstall from PyPI using pip.\n```sh\n$ pip install cooler\n```\n\nIf you are using `conda`, you can alternatively install `cooler` from the [bioconda](https://bioconda.github.io/index.html) channel.\n```sh\n$ conda install -c conda-forge -c bioconda cooler\n```\n\n### Citing\n\nAbdennur, 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).\n\n```bibtex\n@article{cooler2020,\n author = {Abdennur, Nezar and Mirny, Leonid A},\n title = \"{Cooler: scalable storage for Hi-C data and other genomically labeled arrays}\",\n journal={Bioinformatics},\n volume={36},\n number={1},\n pages={311--316},\n year={2020},\n doi = {10.1093/bioinformatics/btz540},\n url = {https://doi.org/10.1093/bioinformatics/btz540},\n}\n```\n\n### Contributing\n\nInterested in contributing to cooler? That's great! To get started, check out the [contributing guide](https://github.com/open2c/cooler/blob/master/CONTRIBUTING.md).\n\n\n### Related projects\n\n- 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))!\n- Visualize your cooler data with [HiGlass](http://higlass.io)!\n- Check out this list of [3D genomics tools and papers](https://github.com/mdozmorov/HiC_tools), most of which accept cooler files.\n\n### Affiliations and Acknowledgements\n\n* Cooler is an Affiliated Project of [NumFOCUS](https://www.numfocus.org/).\n* Cooler development has received support from the NIH [4D Nucleome](https://www.4dnucleome.org/) Consortium.\n* We are grateful for a storage allocation from NSF's [ACCESS Cyberinfrastucture](https://access-ci.org/) Open Storage Network to host example cooler data.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Sparse binary format for genomic interaction matrices.",
"version": "0.10.2",
"project_urls": {
"changelog": "https://github.com/open2c/cooler/blob/master/CHANGES.md",
"documentation": "https://cooler.readthedocs.io",
"homepage": "https://open2c.github.io/cooler",
"repository": "https://github.com/open2c/cooler"
},
"split_keywords": [
"hi-c",
" bioinformatics",
" contact",
" format",
" genomics",
" hdf5",
" matrix",
" sparse"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "784b1a8da8799659aadf1449b2ad9d0cf0cfba3738dc4cb5b338d2c71606ff2c",
"md5": "b56a8c8a03fab6275fa0ae13a263dd67",
"sha256": "4fd30a2981b4a7ab9d7c8074d9b985561902b9984f7bdff594d6fc40ed8cb505"
},
"downloads": -1,
"filename": "cooler-0.10.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b56a8c8a03fab6275fa0ae13a263dd67",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 109249,
"upload_time": "2024-06-17T20:09:33",
"upload_time_iso_8601": "2024-06-17T20:09:33.001686Z",
"url": "https://files.pythonhosted.org/packages/78/4b/1a8da8799659aadf1449b2ad9d0cf0cfba3738dc4cb5b338d2c71606ff2c/cooler-0.10.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e481427493331ebcc63f48bf6bf78e6b54137e638621dadff6354f96a26f818",
"md5": "2afee16791f5da02be77f505bcd7aedb",
"sha256": "3780a2e69b2ec89882dfc2775de5d9b54ccb79569dc5f042b4851599388112dc"
},
"downloads": -1,
"filename": "cooler-0.10.2.tar.gz",
"has_sig": false,
"md5_digest": "2afee16791f5da02be77f505bcd7aedb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11078641,
"upload_time": "2024-06-17T20:09:37",
"upload_time_iso_8601": "2024-06-17T20:09:37.658602Z",
"url": "https://files.pythonhosted.org/packages/5e/48/1427493331ebcc63f48bf6bf78e6b54137e638621dadff6354f96a26f818/cooler-0.10.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-17 20:09:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "open2c",
"github_project": "cooler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cooler"
}
JSON
