Skip to content

Commit

Permalink
Update of README.rst and version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
HaHeho committed Jan 12, 2021
1 parent 458c8f5 commit 43f58ae
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
13 changes: 6 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,13 @@ Sound Field Analysis toolbox for Python
.. image:: https://api.travis-ci.org/QULab/sound_field_analysis-py.svg
.. image:: https://ci.appveyor.com/api/projects/status/u0koxo5vcitmbghc?svg=true

The *sound\_field\_analysis* toolbox (short: *sfa*) is a Python port of the `Sound Field Analysis
Toolbox (SOFiA) toolbox`_, originally by Benjamin Bernschütz `[1]`_. The main goal of the *sfa*
toolbox is to analyze, visualize and process sound field data recorded by spherical microphone
arrays. Furthermore, various types of test-data may be generated to evaluate the implemented
functions. It is an essential building block of `ReTiSAR`_, an implementation of real time
binaural rendering of spherical microphone array data.
The *sound\_field\_analysis* toolbox (short: *sfa*) is a Python port of the `Sound Field Analysis Toolbox (SOFiA) toolbox`_, originally by Benjamin Bernschütz `[1]`_. The main goal of the *sfa* toolbox is to analyze, visualize and process sound field data recorded by spherical microphone arrays. Furthermore, various types of test-data may be generated to evaluate the implemented functions. It is an essential building block of `ReTiSAR`_, an implementation of real time binaural rendering of spherical microphone array data.


Requirements
------------

We use Python 3.7 for development. Chances are that earlier version will work too but this is currently untested.
We use Python 3.9 for development. Chances are that earlier version will work too but this is currently untested.

The following external libraries are required:

Expand Down Expand Up @@ -110,6 +105,10 @@ miro or `SOFA`_ files.
Version history
---------------

*v2021.1.12*
* Update of MIRO struct loading (quadrature weights are now optional)
* Fix to prevent Python 3.8 syntax warnings

*v2020.1.30*
* Update of README and PyPI package

Expand Down
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
setup(
name='sound_field_analysis',
url='https://github.com/AppliedAcousticsChalmers/sound_field_analysis-py/',
version=open('sound_field_analysis/_version.py').readlines()[-1].split()[-1].strip('"\''),
version=open('sound_field_analysis/_version.py', mode='r',
encoding='utf-8').readlines()[-1].split()[-1].strip('"\''),
license='GPLv3',
# license='MIT',

description='Analyze, visualize and process sound field data recorded by spherical microphone arrays.',
description='Analyze, visualize and process sound field data recorded by '
'spherical microphone arrays.',
long_description=open('README.rst', mode='r', encoding='utf-8').read(),
keywords='sound field analysis spherical microphone array',

Expand Down
2 changes: 1 addition & 1 deletion sound_field_analysis/_version.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
"""Version information."""
__version__ = '2020.1.30'
__version__ = '2021.1.12'

0 comments on commit 43f58ae

Please sign in to comment.