Skip to content

nvictus/cooler

This branch is 3 commits ahead of, 44 commits behind open2c/cooler:master.

Folders and files

NameName
Last commit message
Last commit date
Feb 2, 2024
Feb 7, 2024
Mar 8, 2024
Mar 8, 2024
Jan 30, 2024
Mar 4, 2024
Oct 19, 2023
Sep 11, 2023
Jan 17, 2023
Jan 13, 2023
Jan 17, 2023
Jan 4, 2024
Feb 7, 2024

Repository files navigation

Cooler

Cooler

Latest Release latest release pypi latest release bioconda
License license
Build Status build status
Pre-commit Status pre-commit status
Docs Status
Coverage coverage
Downloads pypi downloads bioconda downloads
Citation paper doi zenodo doi
Community slack numfocus

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

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

Affiliations

Cooler is an Affiliated Project of NumFOCUS.

About

A cool place to store your Hi-C

Resources

License

Code of conduct

Citation

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.8%
  • Makefile 0.2%