Sound Propagation with Acoustic Radiosity for Realistic Outdoor Worlds.

Getting Started

Follow our example notebooks to get a sense of the structure and functions of sparrowpy.

Installation

Use pip to install sparrowpy

pip install sparrowpy

(Requires Python >= 3.10)

if numba is installed the code will be precompiled and will run faster. We strongly recommend to use numba to accelerate the simulations significantly

pip install sparrowpy numba

Geometry import via blender or STL files will be supported in a future release, an install of the Blender API. Note that blender has strong requirements on the python version, see pypi. You can install it via pip

pip install bpy

to show progress bars install tqdm

pip install tqdm

by default these packages are not installed

Troubleshooting

Audio file reading/writing in pyfar 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 sparrowpy.