view gmm_baseline_experiments/external_libs/librosa/librosa-0.3.1/docs/install.rst @ 2:cb535b80218a

Remaining scripts and brief documentation

Installation instructions
=========================

The simplest way to install *librosa* is through the Python Package Index (PyPI).  This
will ensure that all required dependencies are fulfilled.  This can be achieved by
executing the following command::

    pip install librosa

or::

    sudo pip install librosa

to install system-wide.

If you've downloaded the archive manually from the `releases
<https://github.com/bmcfee/librosa/releases/>`_ page, you can install using the
`setuptools` script::

    tar xzf librosa-0.3.tar.gz
    cd librosa-0.3/
    python setup.py install

Additional notes
----------------

By default, *librosa* will use `scipy.signal` to resample audio signals, which can 
be slow in practice.  It is highly recommended to install `librsamplerate
<http://www.mega-nerd.com/SRC/>`_ and the corresponding python module,
`scikits.samplerate <https://pypi.python.org/pypi/scikits.samplerate>`_.  

Once these are installed, *librosa* will use the faster `scikits.samplerate` for all 
resampling operations.