Installation

Requirements

Obviously, you’ll need Python. More specifically, you’ll need Python 3. NumPy and SciPy are needed for the calculations. If you want to use the provided functions for plotting sound fields, you’ll need Matplotlib. However, since all results are provided as plain NumPy arrays, you should also be able to use any plotting library of your choice to visualize the sound fields.

Instead of installing all of the requirements separately, you should probably get a Python distribution that already includes everything, e.g. Anaconda.

Installation

Once you have installed the above-mentioned dependencies, you can use pip to download and install the latest release of the Sound Field Synthesis Toolbox with a single command:

python3 -m pip install sfs --user

If you want to install it system-wide for all users (assuming you have the necessary rights), you can just drop the --user option.

To un-install, use:

python3 -m pip uninstall sfs

If you want to install the latest development version of the SFS Toolbox, have a look at Contributing.