Skip to content

pyfar/pyfar

Repository files navigation


PyPI version Documentation Status CircleCI Binder

The python package for acoustics research (pyfar) offers classes to store audio data, filters, coordinates, and orientations. It also contains functions for reading and writing audio data, as well as functions for processing, generating, and plotting audio signals.

Getting Started

The pyfar workshop gives an overview of the most important pyfar functionality and is a good starting point. It is part of the pyfar example gallery that also contains more specific and in-depth examples that can be executed interactively without a local installation by clicking the mybinder.org button on the respective example. The pyfar documentation gives a detailed and complete overview of pyfar. All these information are available from pyfar.org.

Installation

Use pip to install pyfar

pip install pyfar

(Requires Python 3.9 or higher)

Audio file reading/writing is supported through SoundFile, which is based on libsndfile. On Windows and OS X, it will be installed automatically. On Linux, you need to install libsndfile using your distribution’s package manager, for example sudo apt-get install libsndfile1. If the installation fails, please check out the help section.

Contributing

Check out the contributing guidelines if you want to become part of pyfar.