# Music Structure Analysis Framework #

A Python framework to analyze music structure.

[![PyPI version](https://badge.fury.io/py/msaf.svg)](https://badge.fury.io/py/msaf)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/urinieto/msaf/master/LICENSE.md)
[![Build Status](https://github.com/urinieto/msaf/actions/workflows/test.yaml/badge.svg)](https://github.com/urinieto/msaf/actions/workflows/test.yaml)
[![Coverage Status](https://coveralls.io/repos/github/urinieto/msaf/badge.svg?branch=master)](https://coveralls.io/github/urinieto/msaf?branch=master)
[![Documentation Status](https://readthedocs.org/projects/msaf/badge/?version=latest)](https://msaf.readthedocs.io/en/latest/?badge=latest)

## Documentation ##

See https://msaf.readthedocs.io for a complete reference manual and introductory tutorials.

## Installation ##

From the root folder, type:

    pip install .

(Note: you may need to create and activate a Python virtual environment with `python -m venv .venv` and `source .venv/bin/activate` first, depending on your system configuration).

## Demonstration Notebook ##

You can follow a thorough example on this titanic [Jupyter Notebook](https://github.com/urinieto/msaf/blob/main/examples/Run%20MSAF.ipynb).

## Citing MSAF ##

Nieto, O., Bello, J. P., Systematic Exploration Of Computational Music Structure Research. Proc. of the 17th International Society for Music Information Retrieval Conference (ISMIR). New York City, NY, USA, 2016 ([PDF](https://ccrma.stanford.edu/~urinieto/MARL/publications/ISMIR2016-NietoBello.pdf)).

## Credits ##

Created by [Oriol Nieto](http://marl.smusic.nyu.edu/nieto/) (<oriol@nyu.edu>).