peterf@2: Installation instructions
peterf@2: =========================
peterf@2:
peterf@2: The simplest way to install *librosa* is through the Python Package Index (PyPI). This
peterf@2: will ensure that all required dependencies are fulfilled. This can be achieved by
peterf@2: executing the following command::
peterf@2:
peterf@2: pip install librosa
peterf@2:
peterf@2: or::
peterf@2:
peterf@2: sudo pip install librosa
peterf@2:
peterf@2: to install system-wide.
peterf@2:
peterf@2: If you've downloaded the archive manually from the `releases
peterf@2: `_ page, you can install using the
peterf@2: `setuptools` script::
peterf@2:
peterf@2: tar xzf librosa-0.3.tar.gz
peterf@2: cd librosa-0.3/
peterf@2: python setup.py install
peterf@2:
peterf@2: Additional notes
peterf@2: ----------------
peterf@2:
peterf@2: By default, *librosa* will use `scipy.signal` to resample audio signals, which can
peterf@2: be slow in practice. It is highly recommended to install `librsamplerate
peterf@2: `_ and the corresponding python module,
peterf@2: `scikits.samplerate `_.
peterf@2:
peterf@2: Once these are installed, *librosa* will use the faster `scikits.samplerate` for all
peterf@2: resampling operations.