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¶

hictkpy can be installed using pip or conda with e.g., pip install 'hictkpy[all]'. Refer to Installation for more details.

How to cite this project?¶

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

@article{hictk,
    author = {Rossini, Roberto and Paulsen, Jonas},
    title = "{hictk: blazing fast toolkit to work with .hic and .cool files}",
    journal = {Bioinformatics},
    volume = {40},
    number = {7},
    pages = {btae408},
    year = {2024},
    month = {06},
    issn = {1367-4811},
    doi = {10.1093/bioinformatics/btae408},
    url = {https://doi.org/10.1093/bioinformatics/btae408},
    eprint = {https://academic.oup.com/bioinformatics/article-pdf/40/7/btae408/58385157/btae408.pdf},
}

Table of contents¶

API Reference

Python API Reference