Introduction#

hictkpy provides Python bindings to hictk, a blazing fast toolkit to work with .hic and .cool files.

Documentation formats#

You are reading the HTML version of the documentation. An alternative PDF version is also available.

Installation#

Python bindings for hictk can be installed using pip or conda. See here for more details.

How to cite this project?#

Please use the following BibTeX template to cite hictkpy in scientific discourse:

@article {hictk,
        author = {Roberto Rossini and Jonas Paulsen},
        title = {hictk: blazing fast toolkit to work with .hic and .cool files},
        elocation-id = {2023.11.26.568707},
        year = {2023},
        doi = {10.1101/2023.11.26.568707},
        publisher = {Cold Spring Harbor Laboratory},
        URL = {https://www.biorxiv.org/content/early/2023/11/27/2023.11.26.568707},
        eprint = {https://www.biorxiv.org/content/early/2023/11/27/2023.11.26.568707.full.pdf},
        journal = {bioRxiv}
}

Table of contents#

API Reference