Welcome to spaudiopy’s documentation!

Installation

For the unpatient, you can just install the pip version

pip install spaudiopy

Requirements

It’s easiest to start with something like Anaconda as a Python distribution. You’ll need Python >= 3.6 .

  1. Create a conda environment:

    • conda create –name spaudio python=3.6 anaconda joblib portaudio

  2. Activate this new environment:

    • conda activate spaudio

Have a look at the setup.py file, all dependencies are listed there. When using pip to install this package as shown below, all remaining dependencies not available from conda will be downloaded and installed automatically.

Installation

Download this package from GitHub and navigate to there. Then simply run the line:

pip install -e .

This will check all dependencies and install this package as editable.

API Documentation

spaudiopy

Submodules

io

Input Output (IO) helpers.

sig

Signal class.

sph

Spherical Harmonics.

decoder

Loudspeaker decoders.

process

Collection of audio processing tools.

utils

A few helpers.

grids

Sampling grids.

parsa

Parametric Spatial Audio (PARSA).

plot

Plotting helpers.

Multiprocessing

If the function has an argument called jobs_count the implementation allows launching multiple processing jobs. Keep in mind that there is always a certain computational overhead involved, and more jobs is not always faster.

Especially on Windows, you then have to protect your main() function with:

if __name__ == '__main__':
    # Put your code here

Indices and tables