BandHiC
=======

Welcome to the BandHiC documentation!

This documentation provides a comprehensive guide to the BandHiC library, including its features, installation instructions, and API reference.
It is designed to help you efficiently store and manipulate Hi-C contact matrices in a banded form, enabling NumPy-compatible operations, matrix masking, diagonal reduction, file I/O, and domain-level interaction analysis.

Refer to the sections below for detailed information on how to use BandHiC effectively:

Author:  Wang Weibing

Email:   wangweibing@xidian.edu.cn

Web:     https://xdwwb.github.io/BandHiC-Master/

PyPI:    https://pypi.org/project/bandhic/

Github:  https://github.com/xdwwb/BandHiC-Master

.. toctree::
   :maxdepth: 2
   :caption: Contents

   quickstart
   tutorials
   api

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`