Skip to main content

Sparse binary format for genomic interaction matrices.

Project description

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 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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cooler-0.10.3.tar.gz (11.1 MB view details)

Uploaded Source

Built Distribution

cooler-0.10.3-py3-none-any.whl (109.4 kB view details)

Uploaded Python 3

File details

Details for the file cooler-0.10.3.tar.gz.

File metadata

  • Download URL: cooler-0.10.3.tar.gz
  • Upload date:
  • Size: 11.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for cooler-0.10.3.tar.gz
Algorithm Hash digest
SHA256 710319e894c80a81d4df89d2f52750ec0d68c0d91286bc06ffb9d61fc49e435a
MD5 0a460674afbcfb7bed4f5538a0985c51
BLAKE2b-256 34ddfe5b3c0decf37597012d1ec7e37caa49a170c70c632041a380f8bcc24db0

See more details on using hashes here.

Provenance

The following attestation bundles were made for cooler-0.10.3.tar.gz:

Publisher: publish.yml on open2c/cooler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cooler-0.10.3-py3-none-any.whl.

File metadata

  • Download URL: cooler-0.10.3-py3-none-any.whl
  • Upload date:
  • Size: 109.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for cooler-0.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1314c90f0e8a7c93d32ea96962a877e60b1c835dd3f02f9c253307662b341b7a
MD5 46b85bdb7e3962655bcd9212faa41e52
BLAKE2b-256 d3d94ee2ef17ffc109cebba7b1a371c663af556e549d3e4b66cf1beb754cd34e

See more details on using hashes here.

Provenance

The following attestation bundles were made for cooler-0.10.3-py3-none-any.whl:

Publisher: publish.yml on open2c/cooler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page