Metadata-Version: 2.0
Name: sfs
Version: 0.2.0
Summary: Sound Field Synthesis Toolbox
Home-page: http://github.com/sfstoolbox/
Author: SFS Toolbox Developers
Author-email: sfstoolbox@gmail.com
License: MIT
Keywords: audio,SFS,WFS,Ambisonics
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Requires-Dist: numpy
Requires-Dist: scipy

Sound Field Synthesis Toolbox for Python
========================================

Python implementation of the `Sound Field Synthesis Toolbox`_.

.. _Sound Field Synthesis Toolbox: http://github.com/sfstoolbox/sfs/

Documentation:
   http://sfs.rtfd.org/

Code:
   http://github.com/sfstoolbox/sfs-python/

Python Package Index:
   http://pypi.python.org/pypi/sfs/

License:
   MIT -- see the file ``LICENSE`` for details.

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

Obviously, you'll need Python_.
We normally use Python 3.x, but it *should* also work with Python 2.x.
NumPy_ and SciPy_ are needed for the calcuations.
If you also want to plot the resulting sound fields, you'll need matplotlib_.

Instead of installing all of them separately, you should probably get a Python
distribution that already includes everything, e.g. Anaconda_.

.. _Python: http://www.python.org/
.. _NumPy: http://www.numpy.org/
.. _SciPy: http://www.scipy.org/scipylib/
.. _matplotlib: http://matplotlib.org/
.. _Anaconda: http://docs.continuum.io/anaconda/

Installation
------------

Once you have installed the above-mentioned dependencies, you can use pip_
to download and install the latest release of the Sound Field Synthesis Toolbox
with a single command::

   pip install sfs --user

If you want to install it system-wide for all users (assuming you have the
necessary rights), you can just drop the ``--user`` option.

To un-install, use::

   pip uninstall sfs

.. _pip: http://www.pip-installer.org/en/latest/installing.html

How to Get Started
------------------

Various examples are located in the directory examples/

* sound_field_synthesis.py: 
    Illustrates the general usage of the toolbox
* horizontal_plane_arrays.py: 
    Computes the sound fields for various techniques, virtual sources and loudspeaker array configurations
* soundfigures.py: 
    Illustrates the synthesis of sound figures with Wave Field Synthesis


