Metadata-Version: 2.1
Name: carat
Version: 0.1.2
Summary: Computer-Aided Rhythm Analysis Toolbox
Home-page: http://github.com/mrocamora/carat
Author: Martín Rocamora
Author-email: rocamora@fing.edu.uy
License: MIT
Download-URL: http://github.com/mrocamora/carat/releases
Description: carat
        =====
        <pre>
         _  _  __ _ _|_
        (_ (_| | (_| |_   computer-aided rhythm analysis toolbox
        </pre>
        
        
        [![PyPI](https://img.shields.io/pypi/v/carat.svg)](https://pypi.python.org/pypi/carat)
        [![License](https://img.shields.io/github/license/mrocamora/carat.svg)](https://github.com/mrocamora/carat/blob/master/LICENSE.md)
        
        
        Documentation
        -------------
        See [https://carat.readthedocs.io](https://carat.readthedocs.io/en/latest/) for a complete reference manual and introductory tutorials.
        
        
        Demonstration notebooks
        -----------------------
        Some demonstrations of what you can do with carat:
        
        * [Rhythmic patterns demo notebook](http://nbviewer.ipython.org/github/mrocamora/carat/blob/master/examples/carat_rhythmic_patterns_demo.ipynb): how to extract rhythmic patterns from an audio recording.
        * [Microtiming patterns demo notebook](http://nbviewer.ipython.org/github/mrocamora/carat/blob/master/examples/carat_microtiming_patterns_demo.ipynb): how to extract microtiming patterns from an audio recording.
        
        
        Installation
        ------------
        
        The latest stable release is available on PyPI, and you can install it by
        ```
        pip install carat
        ```
        
        To build carat from source, use `python setup.py build`.
        Then, to install carat, say `python setup.py install`.
        If all went well, you should be able to execute the demo scripts under `examples/`
        (OS X users should follow the installation guide given below).
        
        Alternatively, you can download or clone the repository and use `pip` to handle dependencies:
        
        ```
        unzip carat.zip
        pip install -e carat
        ```
        or
        ```
        git clone https://github.com/mrocamora/carat.git
        pip install -e carat
        ```
        
        By calling `pip list` you should see `carat` now as an installed pacakge:
        ```
        carat (0.x.x, /path/to/carat)
        ```
        
        ### Hints for the Installation
        
        `carat` uses `librosa` to load audio files. The following are the installation hints provided by librosa in order to install the needed dependencies to load audio files. 
        
        `librosa` uses `soundfile` and `audioread` to load audio files.
        Note that `soundfile` does not currently support MP3, which will cause librosa to
        fall back on the `audioread` library.
        
        #### soundfile
        
        If you're using `pip` on a Linux environment, you may need to install `libsndfile`
        manually.  Please refer to the [SoundFile installation documentation](https://pysoundfile.readthedocs.io/#installation) for details.
        
        #### audioread and MP3 support
        
        To fuel `audioread` with more audio-decoding power (e.g., for reading MP3 files),
        you may need to install either *ffmpeg* or *GStreamer*.
        
        *Note that on some platforms, `audioread` needs at least one of the programs to work properly.*
        
        Here are some common commands for different operating systems:
        
        * Linux (apt-get): `apt-get install ffmpeg` or `apt-get install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly`
        * Linux (yum): `yum install ffmpeg` or `yum install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly`
        * Mac: `brew install ffmpeg` or `brew install gstreamer`
        * Windows: download binaries from the website
        
        For GStreamer, you also need to install the Python bindings with
        ```
        pip install pygobject
        ```
        
        Citing
        ------
        
        If you want to cite carat please cite the paper published at AAWM 2019:
        
            Rocamora, and Jure. "carat: Computer-Aided Rhythmic Analysis Toolbox." In Proceedings of Analytical Approaches to World Music. 2019.
        
Keywords: audio music sound
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: display
Provides-Extra: docs
Provides-Extra: tests
