epione 0.0.1rc1
EpiOne: Generative cartography of single-cell epigenomes
Requires Python: >=3.9
Keywords: bioinformatics, deep-learning, single-cell, ATAC-seq

<!-- Banner -->
<p align="center">
  <img src="epione_guide/_static/logo.png" alt="Epione Logo" width="400"/>
</p>

<div align="center">

# Epione

***Generative Cartography of Single-Cell Epigenomes***

**A Python framework for single-cell epigenomic analysis**

[![][github-release-shield]][github-release-link]
[![][python-shield]][python-link]
[![][license-shield]][license-link]<br/>
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]<br>

[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
[![Status: Early Development](https://img.shields.io/badge/Status-Early%20Development-orange.svg)]()
[![Single-Cell](https://img.shields.io/badge/Single--Cell-Epigenomics-purple.svg)]()

</div>

## What is Epione?

**Epione** is a Python framework for **single-cell epigenomic analysis** and **generative modeling**. Named after the Greek goddess of healing, Epione aims to provide tools for understanding epigenomic landscapes in single cells.

> ⚠️ **Version 0.0.1**: This is an early development version. Core features are still being implemented.

## Installation

**From source:**
```bash
git clone https://github.com/aristoteleo/epione.git
cd epione
pip install -e .
```

> 📋 PyPI release coming in future versions

## Basic Usage

```python
import epione as epi

# Basic functionality coming soon
# Check documentation for current capabilities
```

## Requirements

- Python 3.9+
- Core dependencies:
  - `numpy`, `pandas`, `scipy`
  - `anndata`
  - Additional dependencies will be defined as features are implemented

## Documentation

Documentation is being developed and will be available at the project website. Current documentation drafts are in the `epione_guide/` directory.

## Development Status

**Version 0.0.1** includes:
- Project structure and basic setup
- Initial documentation framework
- Core package skeleton

**Coming in future versions:**
- Single-cell data processing utilities
- Generative modeling tools
- Visualization functions
- Comprehensive tutorials and examples

## Contributing

This project is in early development. We welcome:

- Feature suggestions and feedback
- Bug reports and issues
- Documentation improvements
- Code contributions

## License

This project is [GPL 3.0](./LICENSE) licensed.

---

**Built for the single-cell epigenomics community**

<!-- Links -->
[github-contributors-link]: https://github.com/aristoteleo/epione/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/aristoteleo/epione?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/aristoteleo/epione/network/members
[github-forks-shield]: https://img.shields.io/github/forks/aristoteleo/epione?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/aristoteleo/epione/issues
[github-issues-shield]: https://img.shields.io/github/issues/aristoteleo/epione?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/aristoteleo/epione/blob/main/LICENSE
[github-release-link]: https://github.com/aristoteleo/epione/releases
[github-release-shield]: https://img.shields.io/github/v/release/aristoteleo/epione?color=369eff&labelColor=black&logo=github&style=flat-square
[github-stars-link]: https://github.com/aristoteleo/epione/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/aristoteleo/epione?color=ffcb47&labelColor=black&style=flat-square

[python-link]: https://www.python.org/
[python-shield]: https://img.shields.io/badge/Python-3.9%2B-blue?logo=python&logoColor=white&style=flat-square
[license-link]: https://github.com/aristoteleo/epione/blob/main/LICENSE
[license-shield]: https://img.shields.io/badge/license-GPL%203.0-white?labelColor=black&style=flat-square