===========
SigZyme
===========

``sigzyme`` is a toolkit of mode decomposition methods.
The latest development version can be found `here <https://github.com/dioph/sigzyme>`_.

Installation
============
``sigzyme`` requires ``torch`` and ``numba``.
Installing the most recent stable version of the package is as easy as::

    pip install sigzyme

Changelog
=========

1.0 (2023-00-00)
----------------

Initial beta release

.. toctree::
    :maxdepth: 2
    :caption: User Guide

.. toctree::
    :maxdepth: 1
    :caption: Tutorials


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`