acoustic-toolbox 0.1.2rc2

Acoustic Toolbox module for Python.

The acoustic-toolbox module is a Python module with useful tools for acousticians.

Installation

The latest release can be found on PyPI and installed with pip install acoustic-toolbox.

Otherwise, you can clone this repository and install with pip install or pip install -e when you want an editable install.

Examples

Several examples can be found in the docs/examples folder.

Tests

The test suite can be run with

uv run pytest

Documentation

Documentation can be found online.

License

acoustic-toolbox is distributed under the BSD 3-clause license. See LICENSE for more information.

Contributing

Contributors are always welcome.

Setting up the development environment and dependency management is done with uv. uv can be installed from source or with pip install uv.

To install the development environment, run uv sync --all-extras in the root of the repository. This will setup a .venv and install all dependencies including dev and docs dependencies.

Documentation and examples are stored in the docs/ folder and built with uv run mkdocs serve or uv run mkdocs build from .

Origin project

This project is based on the amazing work initially done here: python-acoustics