Metadata-Version: 2.4
Name: audiotoolbox
Version: 0.73
Summary: Toolbox for generating and working with audio signals
Author-email: Jörg Encke <encke.joerg@gmail.com>
Project-URL: Homepage, https://jencke.github.io/audiotoolbox/index.html
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: soundfile
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: matplotlib; extra == "docs"
Dynamic: license-file

# audiotoolbox
A python package for creating acoustic stimuli primariliy aimed at auditory research.

[![Documentation Status](https://github.com/Jencke/audiotoolbox/actions/workflows/docs.yml/badge.svg)](https://github.com/Jencke/audiotoolbox/actions/workflows/docs.yml)
[![CI](https://github.com/Jencke/audiotoolbox/actions/workflows/ci.yml/badge.svg)](https://github.com/Jencke/audiotoolbox/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/Jencke/audiotoolbox/branch/develop/graph/badge.svg?token=SI8BRM2ZYZ)](https://codecov.io/gh/Jencke/audiotoolbox)

## How to install audiotoolbox
### Using pip
  If you use `pip`, you can install audiotoolbox with:

 `pip install audiotoolbox`

### From GitHub
 * Clone the repository: `git clone https://github.com/Jencke/audiotoolbox.git`
 * Install the package: `pip install ./`
 * Optionally run the tests: `pytest`

### Requirements
  audiotoolbox depends on the libsndfile library. The libray should be installed automatically when using pip.

## Documentation
The package documentation can be found at: https://jencke.github.io/audiotoolbox/index.html
However, it is a bit outdated and does not document all the features. Help would be highly appreciated

## Contributions
The Project is happy about any contribution. If you find bugs, think the documentation could be improved, or have comments or ideas, open a ticket within the issue tracker https://github.com/Jencke/audiotoolbox/issues or contact me via email. If you implement new features, I'm happy to receive merge requests or code-snippets.

## Acknowledgments
This software package was developed during my PHD in the group of Prof. Werner Hemmert at the Technical University of Munich and further developed during my time as a post-doc in the Group of Prof. Mathias Dietz at the University of Oldenburg.
