LibROSA
=======
LibROSA is a python package for music and audio analysis.  It provides the building
blocks necessary to create music information retrieval systems.

For a quick introduction to using librosa, please refer to the :doc:`tutorial`.
For a more advanced introduction which describes the package design principles, please refer to the 
`librosa paper <http://conference.scipy.org/proceedings/scipy2015/pdfs/brian_mcfee.pdf>`_ at 
`SciPy 2015 <http://scipy2015.scipy.org>`_.

Getting started
---------------
.. toctree::
    :maxdepth: 1

    install
    tutorial


Troubleshooting
---------------

If you have questions about how to use librosa, please consult the `discussion forum 
<https://groups.google.com/forum/#!forum/librosa>`_.
For bug reports and other, more technical issues, consult the `github issues 
<https://github.com/bmcfee/librosa/issues>`_.

API documentation
-----------------

.. toctree::
    :maxdepth: 1

    core
    display
    feature
    onset
    beat
    decompose
    effects
    output
    segment
    util


Advanced topics
---------------

.. toctree::
    :maxdepth: 1

    filters
    cache

Reference
---------

.. toctree::
    :maxdepth: 1

    changelog
    glossary
* :ref:`genindex`
