|
1 |
| -Sound Field Synthesis Toolbox for Python |
2 |
| -======================================== |
| 1 | +Sound Field Synthesis (SFS) Toolbox for Python |
| 2 | +============================================== |
3 | 3 |
|
4 |
| -The Sound Field Synthesis Toolbox for Python gives you the possibility to create |
5 |
| -numercial simulations of sound field synthesis methods like wave field synthesis |
6 |
| -(WFS) or near-field compensated higher order Ambisonics (NFC-HOA). |
7 |
| - |
8 |
| -Theory: |
9 |
| - http://sfstoolbox.org/ |
| 4 | +A Python library for creating numercial simulations of sound field synthesis |
| 5 | +methods like Wave Field Synthesis (WFS) or Near-Field Compensated Higher Order |
| 6 | +Ambisonics (NFC-HOA). |
10 | 7 |
|
11 | 8 | Documentation:
|
12 |
| - http://python.sfstoolbox.org/ |
| 9 | + https://sfs-python.readthedocs.io/ |
13 | 10 |
|
14 | 11 | Source code and issue tracker:
|
15 | 12 | https://github.com/sfstoolbox/sfs-python/
|
16 | 13 |
|
17 |
| -Python Package Index: |
18 |
| - https://pypi.python.org/pypi/sfs/ |
19 |
| - |
20 |
| -SFS Toolbox for Matlab: |
21 |
| - http://matlab.sfstoolbox.org/ |
22 |
| - |
23 | 14 | License:
|
24 | 15 | MIT -- see the file ``LICENSE`` for details.
|
25 | 16 |
|
26 | 17 | Quick start:
|
27 |
| - * Install NumPy, SciPy and Matplotlib |
| 18 | + * Install Python 3, NumPy, SciPy and Matplotlib |
28 | 19 | * ``python3 -m pip install sfs --user``
|
29 |
| - * ``python3 doc/examples/horizontal_plane_arrays.py`` |
| 20 | + * Check out the examples in the documentation |
| 21 | + |
| 22 | +More information about the underlying theory can be found at |
| 23 | +https://sfs.readthedocs.io/. |
| 24 | +There is also a Sound Field Synthesis Toolbox for Octave/Matlab, see |
| 25 | +https://sfs-matlab.readthedocs.io/. |
0 commit comments