peterf@2: librosa
peterf@2: =======
peterf@2: A python package for music and audio analysis.  The primary purpose of librosa is to implement common tools for low- and high-level signal-based music analysis.
peterf@2: 
peterf@2: 
peterf@2: Documentation
peterf@2: -------------
peterf@2: See http://bmcfee.github.io/librosa/ for a complete reference manual and introductory tutorials.
peterf@2: 
peterf@2: 
peterf@2: Demonstration notebooks
peterf@2: -----------------------
peterf@2: What does librosa do?  Here are some quick demonstrations:
peterf@2: 
peterf@2: * [Introduction notebook](http://nbviewer.ipython.org/github/bmcfee/librosa/blob/master/examples/LibROSA%20demo.ipynb): a brief introduction to some commonly used features.
peterf@2: * [Decomposition and IPython integration](http://nbviewer.ipython.org/github/bmcfee/librosa/blob/master/examples/LibROSA%20audio%20effects%20and%20playback.ipynb): an intermediate demonstration, illustrating how to process and play back sound
peterf@2: * [SciKit-Learn integration](http://nbviewer.ipython.org/github/bmcfee/librosa/blob/master/examples/LibROSA%20sklearn%20feature%20pipeline.ipynb): an advanced demonstration, showing how to tie librosa functions to feature extraction pipelines for machine learning
peterf@2: 
peterf@2: 
peterf@2: Installation
peterf@2: ------------
peterf@2: 
peterf@2: The latest stable release is available on PyPI, and you can install it by saying 
peterf@2: ```
peterf@2: pip install librosa
peterf@2: ```
peterf@2: 
peterf@2: To build librosa from source, say `python setup.py build`.
peterf@2: Then, to install librosa, say `python setup.py install`.
peterf@2: If all went well, you should be able to execute the demo scripts under `examples/`.
peterf@2: 
peterf@2: Alternatively, you can download or clone the repository and use `easy_install` to handle dependencies:
peterf@2: 
peterf@2: ```
peterf@2: unzip librosa.zip
peterf@2: easy_install librosa
peterf@2: ```
peterf@2: or
peterf@2: ```
peterf@2: git clone https://github.com/bmcfee/librosa.git
peterf@2: easy_install librosa
peterf@2: ```
peterf@2: 
peterf@2: 
peterf@2: Discussion
peterf@2: ----------
peterf@2: 
peterf@2: Please direct non-development questions and discussion topics to our web forum at 
peterf@2: https://groups.google.com/forum/#!forum/librosa 
peterf@2: 
peterf@2: 
peterf@2: Citing
peterf@2: ------
peterf@2: 
peterf@2: Please refer to the Zenodo link below for citation information.
peterf@2: 
peterf@2: [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.10705.png)](http://dx.doi.org/10.5281/zenodo.10705)
peterf@2: 
peterf@2: