Libfmp API Documentation
========================

This webpage contains the API documentation for the Python package libfmp.
This package goes hand in hand with the FMP Notebooks, a collection of educational material for teaching and learning Fundamentals of Music Processing (FMP) with a particular focus on the audio domain.
For detailed explanations and example applications of the libfmp-functions, we refer to the FMP Notebooks:

http://audiolabs-erlangen.de/FMP

The source code for the package libfmp is hosted at GitHub:

https://github.com/meinardmueller/libfmp

If you use the package libfmp, please consider the following references.

.. [#] Meinard Müller and Frank Zalkow. `libfmp: A Python Package for Fundamentals of Music Processing. <https://joss.theoj.org/papers/10.21105/joss.03326>`_ Journal of Open Source Software (JOSS), 6(63), 2021.

.. [#] Meinard Müller and Frank Zalkow. `FMP Notebooks: Educational Material for Teaching and Learning Fundamentals of Music Processing. <https://archives.ismir.net/ismir2019/paper/000069.pdf>`_ Proceedings of the International Conference on Music Information Retrieval (ISMIR), pp. 573–580, Delft, The Netherlands, 2019.

.. [#] Meinard Müller. `Fundamentals of Music Processing – Using Python and Jupyter Notebooks. <http://www.music-processing.de/>`_ Springer Verlag, 2nd edition, 2021.

.. [#] Meinard Müller. `An Educational Guide Through the FMP Notebooks for Teaching and Learning Fundamentals of Music Processing. <https://www.mdpi.com/2624-6120/2/2/18>`_ Signals, 2(2): 245–285, 2021.

.. toctree::
    :hidden:

    getting_started


.. toctree::
    :caption: API Documentation
    :maxdepth: 1
    :hidden:

    index_b
    index_c1
    index_c2
    index_c3
    index_c4
    index_c5
    index_c6
    index_c7
    index_c8

.. toctree::
    :caption: Reference
    :maxdepth: 1
    :hidden:

    genindex
    py-modindex