Skip to content

achabotl/pambox

Repository files navigation

Python Auditory Modeling Toolbox

image

Documentation Status

pambox is a Python toolbox to facilitate the development of auditory models, with a focus on speech intelligibility prediction models.

The project is maintained by @AlexChabotL.

pambox provides a consistent API for speech intelligibility models, inspired by Scikit-learn, to facilitate comparisons across models.

Dependencies

pambox is tested to work under Python 2.7 and Python 3.4 (thanks to six). Only Mac OS X (10.9) has been tested thoroughly.

The main dependencies are :

Lower versions of these packages are likely to work as well but have not been thoroughly tested.

pyaudio is required if you want to use the audio module.

For running tests, you will need pytest and pytest-cov.

Install

Right now, pambox is only avaible through Github. It should be available via pip soon. To install pambox from source:

git clone https://github.com/achabotl/pambox.git
cd pambox
python setup.py install

If you need more details, see the [Installation](https://github.com/achabotl/pambox/wiki/Installation) page on the wiki.

Contributing

You can check out the latest source and install it for development with:

git clone https://github.com/achabotl/pambox.git
cd pambox
python setup.py develop

To run tests (you will need pytest), from the root pambox folder, type:

python setup.py test

License

pambox is licensed under the New BSD License (3-clause BSD license).