.. SPIEGEL documentation master file, created by
   sphinx-quickstart on Sat Dec 14 14:17:22 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SpiegeLib
=========
Synthesizer Programming with Intelligent Exploration, Generation, and Evaluation Library

.. image:: https://badge.fury.io/py/spiegelib.svg
   :target: https://badge.fury.io/py/spiegelib

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg

----

An object oriented Python library for research and development related to Automatic
Synthesizer Programming. SpiegeLib contains a set of classes and base classes for
developing and evaluating algorithms for generating parameters and patch settings
for synthesizers.

*SpiegeLib* is named after composer Laurie Spiegel, an early pioneer in electronic music.
She is known for her work with synthesizers and for automating various aspects of
the music composition process. Her philosophy for using technology and automation in music
serves as motivation for this project:

"I automate whatever can be automated to be freer to focus on those aspects of music that can't be automated. The challenge is to figure out which is which."

To learn more about Laurie Spiegel and her work visit her `website <http://retiary.org/ls/>`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

First Steps
-----------
.. toctree::
   :maxdepth: 2

   Getting Started <getting_started/getting_started>

SpiegeLib Reference
-------------------
.. toctree::
   :maxdepth: 2

   Core <reference/core>
   Synthesizers <reference/synth>
   Audio Feature Extraction <reference/features>
   Estimators <reference/estimators>
   Evaluation <reference/evaluation>
   Network <reference/network>

Examples
--------
.. toctree::
   :maxdepth: 2

   Examples <examples/examples_index>

Contributing
------------
.. toctree::
   :maxdepth: 2

   Contribution Guide <contributing>


Indices and tables
------------------

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