Python API Reference

This section provides a detailed reference for the hictkpy Python API.

The API is organized in three categories:

• Generic API – Documents classes and functions such as hictkpy.File and hictkpy.PixelSelector that are used to open, inspect, and fetch interactions from .[m]cool and .hic files. The documentation also covers several general-purpose classes and data structures such as hictkpy.BinTable, hictkpy.Bin, and hictkpy.Pixel which are utilized across the API.

• Cooler API – Documents the hictkpy.cooler.SingleCellFile and hictkpy.cooler.FileWriter classes, which are used to access .scool files and create .cool files, respectively.

• .hic API – Documents the hictkpy.hic.FileWriter class, which is used to create .hic files.

• Logging API – Documents how to tweak hictkpy’s logging.Logger.