Metadata-Version: 2.4
Name: scyseq
Version: 0.1.0
Summary: Provides objects and tools to analyze symbolic sequences
Author-email: Laurent Pezard <laurent.pezard@univ-amu.fr>, Jean-Luc Blanc <jean-luc.blanc@univ-amu.fr>
License: BSD-3
License-File: LICENSE
Requires-Python: >=3.8
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs
Requires-Dist: ipykernel; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: nbsphinx; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-gallery; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex; extra == 'docs'
Description-Content-Type: text/markdown

# `scyseq`: Symbolic Sequences Processing in Python

`scyseq` is a `Python` package for generating, defining, manipulating, characterizing and
plotting _symbolic sequences_ which are defined as successive occurrences of
symbols (or states) taken from a finite-length alphabet (set of states).

## Overview

`scyseq` provides:

- adapted objects: symbols, alphabet and sequence
- functions for symbolic sequence manipulations: rename, recode, etc.
- visualisations functions
- functions for symbolic sequences analysis from simple countings to
  information theory or Markov processes.

Its documentation is available at:
[scyseq-tools.github.io/scyseq](https://scyseq-tools.github.io/scyseq/).

Another Python package dealing with symbolic sequences with a complementary point
of view is: [slearn](https://github.com/nla-group/slearn)

## Installation

`scyseq` is available on pypi
[pypi.org/project/scyseq](https://pypi.org/project/scyseq)
so:

```bash
pip install scyseq
```

should do the job...

### Dependencies:

- numpy
- scipy, and
- matplotlib

###  Tools used in this package:

[![Sphinx](https://img.shields.io/badge/docs-Sphinx-blue)](https://www.sphinx-doc.org/)
[![pytest](https://img.shields.io/badge/tests-pytest-blue)](https://docs.pytest.org/)
[![Hatch](https://img.shields.io/badge/project-Hatch-blue)](https://hatch.pypa.io/latest/)
[![doctest](https://img.shields.io/badge/tests-doctest-blue)](https://docs.python.org/3/library/doctest.html)

### 

## License

This project is licensed under the [BSD 3-Clause](https://github.com/scyseq-tools/scyseq/blob/master/LICENSE)

## Contributing

Contributions to `scyseq` are welcome! 

To contribute:

1. Fork the repository: [github.com/scyseq-tools/scyseq](https://github.com/scyseq-tools/scyseq)
2. Create a branch for your feature or bug fix.
3. Submit a pull request with a clear description of changes.
4. Ensure tests pass.

See also: [code of conduct](https://github.com/scyseq-tools/scyseq/blob/master/CODE_OF_CONDUCT.md)
