README.md

---
license: mit
language:
- en
---
medleydb
========

Annotations and Python tools for MedleyDB. [Read the Docs here](http://medleydb.readthedocs.org).

[![Documentation Status](https://readthedocs.org/projects/medleydb/badge/?version=latest)](http://medleydb.readthedocs.io/en/latest/?badge=latest)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/marl/medleydb/master/LICENSE.md)
[![PyPI](https://img.shields.io/pypi/pyversions/Django.svg?maxAge=2592000)]()

[![Coverage Status](https://coveralls.io/repos/github/marl/medleydb/badge.svg?branch=master)](https://coveralls.io/github/marl/medleydb?branch=master)

Maintained by Rachel Bittner rachel (dot) bittner (at) nyu (dot) edu.

This code is released along with [MedleyDB](http://medleydb.weebly.com) and is a component of the work presented in the following publications:

[R. Bittner](https://github.com/rabitt), [J. Salamon](https://github.com/justinsalamon), M. Tierney, M. Mauch, [C. Cannam](https://github.com/cannam) and J. P. Bello,
"[MedleyDB: A Multitrack Dataset for Annotation-Intensive MIR Research](http://marl.smusic.nyu.edu/medleydb_webfiles/bittner_medleydb_ismir2014.pdf)", in
15th International Society for Music Information Retrieval Conference,
Taipei, Taiwan, Oct. 2014.

[R. Bittner](https://github.com/rabitt), [J. Wilkins](https://github.com/jlw365), [H. Yip](https://github.com/hmyip1) and J. P. Bello,
"[MedleyDB 2.0: New Data and a System for Sustainable Data Collection](https://wp.nyu.edu/ismir2016/wp-content/uploads/sites/2294/2016/08/bittner-medleydb.pdf)", in
Proceedings of the 17th International Society for Music Information Retrieval Conference Late Breaking and Demo Papers,
New York City, USA, Aug. 2016.


See Also
========
[MedleyDeBugger](https://github.com/marl/medley-de-bugger)

[MedleyDB Manager](https://github.com/marl/medleydb_manager)


Annotations
===========
As of v1.2, this repository contains the most up to date version of the
medleydb annotations. If you find any problems with an annotation, or would
like to contribute annotations, please report an issue submit a pull request. :)

Setup
=====

First clone this repository:

```bash
git clone https://github.com/marl/medleydb.git
```

Install the package

```bash
cd medleydb
pip install .
```

Next, set the environment variable MEDLEYDB_PATH to the local path where
the MedleyDB directory (or MedleyDB_sample) lives:

```bash
export MEDLEYDB_PATH="path/to/your/copy/of/MedleyDB"
```

To avoid doing this step every time, copy the line above to ```~/.bash_profile```
or ```~/.bashrc```.

Dependencies
------------

* Python, will be installed by pip
  * [librosa](https://bmcfee.github.io/librosa/)
  * [numpy](http://www.numpy.org/)
  * [pyyaml](http://pyyaml.org/)
  * [sox](https://github.com/rabitt/pysox)

If you use homebrew, you can install sox by doing:

```bash
brew install sox  # install the binary
pip install sox  # install the python package
```

Known Issues
============
Known issues with the Audio and Metadata can be found [here](https://github.com/marl/medleydb/blob/master/ERRATA.md).