Metadata-Version: 2.4
Name: hicompass
Version: 1.0.1
Summary: Hi-Compass: Depth-aware deep learning framework for cell-type-specific chromatin interaction prediction from ATAC-seq
Home-page: https://github.com/EndeavourSyc/Hi-Compass/
Author: Yuanchen Sun
Author-email: 2247143021@qq.com
License: MIT
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scikit-image
Requires-Dist: pyBigWig
Requires-Dist: cooler
Requires-Dist: pysam
Requires-Dist: piq
Requires-Dist: matplotlib
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


# Hi-Compass

Hi-Compass (High-resolution Chromatin Organization Mapping from ATAC-Seq Signals) is a depth-aware multi-modal deep learning framework for predicting cell-type-specific chromatin interactions from ATAC-seq data.

## Installation

**Important**: Hi-Compass requires PyTorch but does not install it automatically, as the correct version depends on your system and CUDA configuration.

1. First, install PyTorch following the instructions at [pytorch.org](https://pytorch.org/get-started/locally/)

2. Then install Hi-Compass:
```bash
pip install hicompass
```

3. If you plan to train models (optional):
```bash
pip install hicompass[train]
```

## Documentation

Full documentation and tutorials are available at: https://github.com/EndeavourSyc/Hi-Compass

## License

MIT License
