.. nussl documentation master file, created by
   sphinx-quickstart on Sun Feb 23 22:45:37 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: ./nussl-logo-v1.png
    :width: 201px
    :align: center
    :height: 150px
    :alt: nussl logo


*nussl* (pronounced `nuzzle <http://www.thefreedictionary.com/nuzzle>`_) [#f1]_ is a flexible,
object oriented python audio source separation library created by the
`Interactive Audio Lab <http://music.cs.northwestern.edu>`_ at Northwestern University.
At its core, *nussl* provides implementations of common source separation algorithms as well as an
easy-to-use framework for prototyping and adding new algorithms. The aim of *nussl* is to create a
low barrier to entry for using popular source separation algorithms, while also allowing the user
fine tuned control of low-level parameters.



First steps
-----------
.. toctree::
    :maxdepth: 4

    getting_started

Tutorials
---------

.. toctree::
    :maxdepth: 4

    tutorials

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

   examples/examples

Recipes
-------
.. toctree::
    :maxdepth: 4

   recipes/recipes

API Documentation
-----------------
.. toctree::
   :maxdepth: 1

   api

Citing *nussl*
--------------
.. toctree::
   :maxdepth: 1

   citation

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

    contributing

Troubleshooting
---------------
For bug reports and issues with this code, please see the `github issues page
<https://github.com/interactiveaudiolab/nussl/issues>`_. Please review open issues before contacting
the authors.

Changelog
---------
.. toctree::
    :maxdepth: 1

    changelog

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

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


.. rubric:: Footnotes

.. [#f1] Officially stands for "Northwestern University Source Separation Library", but in our
         hearts *nussl* stands for "Needs Unmixing? Source Separation Library!"