Metadata-Version: 2.4
Name: acoustic-toolbox
Version: 0.2.1
Summary: Acoustic Toolbox module for Python.
Author: Valentin LE BESCOND, Andrew Mitchell
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
License-File: LICENSE
Requires-Dist: numpy>=1.23.5
Requires-Dist: scipy>=1.14.0
Requires-Dist: matplotlib>=3.9.1
Requires-Dist: six>=1.16.0
Requires-Dist: pandas>=2.2.2
Requires-Dist: tabulate>=0.9.0
Requires-Dist: pysoundfile>=0.9.0.post1
Requires-Dist: pyoctaveband>=1.1.3
Requires-Dist: numba>=0.59.0
Requires-Dist: jupyter>=1.0.0 ; extra == "docs"
Requires-Dist: mkdocs>=1.6.1 ; extra == "docs"
Requires-Dist: mkdocs-material>=9.5.9 ; extra == "docs"
Requires-Dist: mkdocs-include-markdown-plugin>=6.0.4 ; extra == "docs"
Requires-Dist: mkdocs-exclude>=1.0.2 ; extra == "docs"
Requires-Dist: mkdocs-macros-plugin>=1.0.4 ; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.26.2 ; extra == "docs"
Requires-Dist: mkdocs-jupyter>=0.25.1 ; extra == "docs"
Project-URL: Bug Tracker, https://github.com/Universite-Gustave-Eiffel/acoustic-toolbox/issues
Project-URL: Homepage, https://github.com/Universite-Gustave-Eiffel/acoustic-toolbox
Provides-Extra: docs

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](http://acoustic-toolbox.readthedocs.io/).

## 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](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer) 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](https://github.com/python-acoustics/python-acoustics)

