richarddeffner/pyfar

Readme

pyfar - Python package for acoustic research.

Getting Started

There is no stable release and therefore no binary distribution yet. Hence, the package needs to be installed from source.

Requirements

• Python 3 (>= 3.8 recommended)
• Python packages: numpy, scipy, matplotlib, python-sofa, urllib3

Installation

The sources for spharpy can be downloaded from the git repository.

You can either clone the public repository

$ git clone git@github.com:pyfar/pyfar.git

or download the code as zip archive.

You can install it by running

$ python setup.py install

in the pyfar directory. The required packages to install the package can be installed using pip:

$ pip install -r requirements_dev.txt

When actively developing for the package it is recommended to use a virtual environment and install using the develop option:

$ python setup.py develop

Building the Documentation

We do not yet host the documentation on a public server. The documentation can however be built locally using Sphinx by executing the make script inside the docs folder.

$ cd docs/
$ make html

After Sphinx finishes the documentation you can open the generated html found in

$ docs/_build/index.html

using any browser.

$ make html

inside the docs folder. For more information refer to the contribution guidelines.