sparrowpy 0.1.0

Project for data formats in acoustics.

Python Boilerplate contains all the boilerplate you need to create a Python package.

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 sparrowpy

pip install sparrowpy

(Requires Python >= 3.9)

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[fast]

or

pip install sparrowpy
pip install numba

you can also use blender for geometry import. 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

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.