pyscreech 0.0.5

PyScreech - Audio Performance Library

Overview

PyScreech is a toolbox for calculating useful performance metrics associated with audio recordings such as Speech Transmission Index (STI).

Getting Started

The easiest way to get started is to install the most recent package from PyPI using:

pip install pyscreech

If you would like to install from a local version of the repo, you can use:

pip install .

If you intend to develop on the code, its often useful to do:

pip install -e ."[developer]"

Usage

Example usage:

Testing

Try to run

python -m pyscreech.cli STIPA resources/StipaV5_CEA.wav

Or to test a STOI score, run

python -m pyscreech.cli STOI resources/StipaV5_CEA.wav

A STIPA score of 1.0 should be obtained. For more command line options, type

python -m pyscreech.cli -h

FAQs

Contributing

Pyscreech is an open source project and as such we welcome contributions! Please reach out to [e-mail] if you need help getting started.

Acknowledgment

This material is based upon work supported by the Defense Advanced Research Projects Agency (DARPA) under Contract No. HR001120C0114. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the Defense Advanced Research Projects Agency (DARPA).

pyscreech

Set of Tools to calculate performance characteristics of audio recordings