Skip to main content

PyScreech - Audio Performance Library

Project description

CI PyPI Status Badge PyPI - Python Version License: MIT Docs Code style: black DOI

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 seth.s.henshaw@leidos.com 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyscreech-0.0.4.tar.gz (18.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyscreech-0.0.4-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file pyscreech-0.0.4.tar.gz.

File metadata

  • Download URL: pyscreech-0.0.4.tar.gz
  • Upload date:
  • Size: 18.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for pyscreech-0.0.4.tar.gz
Algorithm Hash digest
SHA256 5b46a36d68ec8c568532fc508d593ab3a64a6492f780bd27b8142e4565e2bf71
MD5 cd46c27e709525478b29eb02a690b3a9
BLAKE2b-256 4829aa993461415733d824140bb947aee25e21888ca60f6efa298bbf7a0bf6fd

See more details on using hashes here.

File details

Details for the file pyscreech-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: pyscreech-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for pyscreech-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0140c7f20eb477391004b86639b633b7870cb78df9cf4cff6b2d9ca4a59ad40a
MD5 05cbc5438a6df3e677c650173547a62d
BLAKE2b-256 a12ce56cf78a448040032ce64b64a03a34f638d69157cd31516b46d964d158e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page