Metadata-Version: 2.5
Name: kaosPy
Version: 0.1.0
Summary: Python package for encoding sequences using chaos game representation.
Project-URL: Homepage, https://github.com/HFLoechel/kaosPy
Author-email: Hannah Franziska Loechel <hannahfranziska.loechel@uni-muenster.de>, Moritz Grunert <mgrunert@uni-muenster.de>, Sandra Clemens <sandra.clemens@uni-muenster.de>
License-Expression: MIT
License-File: LICENSE
Keywords: cgr,chaos game representation,fcgr,frequency chaos game representation,sequence embedding
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.13
Requires-Dist: matplotlib>=3.10
Requires-Dist: numpy>=2.2
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Description-Content-Type: text/markdown

# kaosPy

kaosPy is a Python package for generating **Chaos Game Representation (CGR)**
and **Frequency Chaos Game Representation (FCGR)** of symbolic sequences.

It transforms sequences with arbitrary alphabets into two-dimensional
representations. CGR provides a geometric representation of sequence
composition, while FCGR converts the representation into a frequency-based
matrix.

kaosPy can be used for applications such as:

- sequence embeddings for machine learning,
- alignment-free sequence comparison,
- visualization and exploration of biological sequences,
- phylogenetic and comparative sequence analysis.

## Quickstart

Install kaosPy using pip:

```bash
pip install kaospy

from kaospy import CGR, FCGR

sequence = "ACGTACGTACGT"

cgr = CGR(sequence, symbols="DNA")
fcgr = FCGR(cgr, resolution=16)

fcgr.plot()

```
The same framework can be applied to different symbolic alphabets, including
protein sequences.

## Documentation

Full documentation, examples, and tutorials are available at:

https://github.com/HFLoechel/kaosPy

## Publication

If you use kaosPy in your research, please cite:

TBA


