Real-Time Spherical Microphone Renderer for binaural reproduction in Python

ReTiSAR

Implementation of the Real-Time Spherical Microphone Renderer for binaural reproduction in Python.

macOS (tested on 10.14 Mojave and 10.15 Catalina) or Linux (tested on 5.9.1-1-rt19-MANJARO)
(Windows is not supported due to an incompatibility with the current multiprocessing implementation)
JACK library (prebuilt installers / binaries are available)
Conda installation (miniconda is sufficient; provides an easy way to get Intel MKL or alternatively OpenBLAS optimized numpy versions which is highly recommended)
Python installation (tested with 3.7 to 3.9; recommended way to get Python is to use Conda as described in the setup section)
Installation of the required Python packages (recommended way is to use Conda as described in the setup section)
Optional: Download of publicly available measurement data for alternative execution modes (always check the command line output or log files in case the rendering pipeline does not initialize successfully!)
Optional: Install an OSC client for real-time feedback and remote control options during runtime

Clone repository with command line or any other git client:

git clone https://github.com/AppliedAcousticsChalmers/ReTiSAR.git
- Alternative: Download and extract snapshot manually from provided URL (not recommended due to not being able to pull updates)
- Alternative: Update your local copy with changes from the repository (if you have cloned it in the past):
  
  git pull
Navigate into the repository (the directory containing setup.py):

cd ReTiSAR/
Install required Python packages i.e., Conda is recommended:
- Make sure that Conda is up to date:
  
  conda update conda
- Create new Conda environment from the specified requirements (--force to overwrite potentially existing outdated environment):
  
  conda env create --file environment.yml --force
- Activate created Conda environment:
  
  source activate ReTiSAR