Skip to content

Commit

Permalink
updated install documentation for conda
Browse files Browse the repository at this point in the history
  • Loading branch information
bmcfee committed Jul 18, 2016
1 parent c8660f2 commit b7a1554
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 10 deletions.
22 changes: 19 additions & 3 deletions README.md
Expand Up @@ -3,13 +3,19 @@ librosa
A python package for music and audio analysis.

[![PyPI](https://img.shields.io/pypi/v/librosa.svg)](https://pypi.python.org/pypi/librosa)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/librosa/badges/version.svg)](https://anaconda.org/conda-forge/librosa)
[![License](https://img.shields.io/pypi/l/librosa.svg)](https://github.com/librosa/librosa/blob/master/LICENSE.md)
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.32193.svg)](http://dx.doi.org/10.5281/zenodo.32193)

[![Build Status](https://travis-ci.org/librosa/librosa.png?branch=master)](http://travis-ci.org/librosa/librosa?branch=master)
[![Coverage Status](https://coveralls.io/repos/librosa/librosa/badge.svg?branch=master)](https://coveralls.io/r/librosa/librosa?branch=master)
[![Dependency Status](https://dependencyci.com/github/librosa/librosa/badge)](https://dependencyci.com/github/librosa/librosa)

[![Linux](https://circleci.com/gh/conda-forge/librosa-feedstock.svg?style=svg)](https://circleci.com/gh/conda-forge/librosa-feedstock)
[![OSX](https://travis-ci.org/conda-forge/librosa-feedstock.svg?branch=master)](https://travis-ci.org/conda-forge/librosa-feedstock)
[![Windows](https://ci.appveyor.com/api/projects/status/github/conda-forge/librosa-feedstock?svg=True)](https://ci.appveyor.com/project/conda-forge/librosa-feedstock/branch/master)


Documentation
-------------
See http://librosa.github.io/librosa/ for a complete reference manual and introductory tutorials.
Expand All @@ -31,6 +37,15 @@ The latest stable release is available on PyPI, and you can install it by saying
pip install librosa
```

Anaconda users can install using ``conda-forge``:
```
conda install -c conda-forge librosa
```
If you use Anaconda on Windows, we recommend installing the `gstreamer` and/or
`ffmpeg` libraries separately, as they are not (yet) available as conda
packages.


To build librosa from source, say `python setup.py build`.
Then, to install librosa, say `python setup.py install`.
If all went well, you should be able to execute the demo scripts under `examples/`
Expand All @@ -53,14 +68,15 @@ By calling `pip list` you should see `librosa` now as an installed pacakge:
librosa (0.x.x, /path/to/librosa)
```

### Hints for OS X
### Hints for OS X and Windows

#### ffmpeg

To fuel `audioread` with more audio-decoding power, you can install *ffmpeg* which
ships with many audio decoders.
ships with many audio decoders. (Note: if you are using the conda package for
`audioread`, this will be done automatically.)

You can use *homebrew* to install the programm by calling
You can use *homebrew* to install the program by calling
`brew install ffmpeg` or get a binary version from their website https://www.ffmpeg.org.

Discussion
Expand Down
30 changes: 23 additions & 7 deletions docs/install.rst
@@ -1,9 +1,11 @@
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::
pypi
~~~~
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

Expand All @@ -17,6 +19,17 @@ to install system-wide, or::

to install just for your own user.

conda
~~~~~
If you use conda/Anaconda environments, librosa can be installed from the
`conda-forge` channel::

conda install -c conda-forge librosa


Source
~~~~~~

If you've downloaded the archive manually from the `releases
<https://github.com/librosa/librosa/releases/>`_ page, you can install using the
`setuptools` script::
Expand All @@ -25,14 +38,17 @@ If you've downloaded the archive manually from the `releases
cd librosa-VERSION/
python setup.py install

Additional notes for OS X
-------------------------
Alternately, the latest development version can be installed via pip::

pip install git+https://github.com/librosa/librosa


ffmpeg
------

To fuel `audioread` with more audio-decoding power, you can install *ffmpeg* which
ships with many audio decoders.
ships with many audio decoders. Note that conda users on Linux and OSX will
have this installed by default; Windows users must install ffmpeg separately.

You can use *homebrew* to install the programm by calling
OSX users can use *homebrew* to install ffmpeg by calling
`brew install ffmpeg` or get a binary version from their website https://www.ffmpeg.org.

0 comments on commit b7a1554

Please sign in to comment.