annotate gmm_baseline_experiments/external_libs/librosa/README.md @ 5:b523456082ca tip

Update path to dataset and reflect modified chunk naming convention.
author peterf
date Mon, 01 Feb 2016 21:35:27 +0000
parents cb535b80218a
children
rev   line source
peterf@2 1 librosa
peterf@2 2 =======
peterf@2 3 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 4
peterf@2 5
peterf@2 6 Documentation
peterf@2 7 -------------
peterf@2 8 See http://bmcfee.github.io/librosa/ for a complete reference manual and introductory tutorials.
peterf@2 9
peterf@2 10
peterf@2 11 Demonstration notebooks
peterf@2 12 -----------------------
peterf@2 13 What does librosa do? Here are some quick demonstrations:
peterf@2 14
peterf@2 15 * [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 16 * [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 17 * [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 18
peterf@2 19
peterf@2 20 Installation
peterf@2 21 ------------
peterf@2 22
peterf@2 23 The latest stable release is available on PyPI, and you can install it by saying
peterf@2 24 ```
peterf@2 25 pip install librosa
peterf@2 26 ```
peterf@2 27
peterf@2 28 To build librosa from source, say `python setup.py build`.
peterf@2 29 Then, to install librosa, say `python setup.py install`.
peterf@2 30 If all went well, you should be able to execute the demo scripts under `examples/`.
peterf@2 31
peterf@2 32 Alternatively, you can download or clone the repository and use `easy_install` to handle dependencies:
peterf@2 33
peterf@2 34 ```
peterf@2 35 unzip librosa.zip
peterf@2 36 easy_install librosa
peterf@2 37 ```
peterf@2 38 or
peterf@2 39 ```
peterf@2 40 git clone https://github.com/bmcfee/librosa.git
peterf@2 41 easy_install librosa
peterf@2 42 ```
peterf@2 43
peterf@2 44
peterf@2 45 Discussion
peterf@2 46 ----------
peterf@2 47
peterf@2 48 Please direct non-development questions and discussion topics to our web forum at
peterf@2 49 https://groups.google.com/forum/#!forum/librosa
peterf@2 50
peterf@2 51
peterf@2 52 Citing
peterf@2 53 ------
peterf@2 54
peterf@2 55 Please refer to the Zenodo link below for citation information.
peterf@2 56
peterf@2 57 [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.10705.png)](http://dx.doi.org/10.5281/zenodo.10705)
peterf@2 58
peterf@2 59