Documentation of radial functions

Author: spors

doc/index.rst

@@ -4,6 +4,10 @@
 
 .. toctree::
 
+    usage
+    modal
+    utilities
+
 .. only:: html
 
     * :ref:`genindex`

doc/modal.rst

@@ -0,0 +1,14 @@
+Modal Beamforming
+=================
+
+.. automodule:: micarray.modal
+
+Angular
+-------
+
+.. automodule:: micarray.modal.angular
+
+Radial
+------
+
+.. automodule:: micarray.modal.radial

doc/usage.rst

@@ -0,0 +1,24 @@
+Usage
+=====
+
+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 calculations.
+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/
+
+How to Get Started
+------------------
+
+Various examples are located in the directory 

doc/utilities.rst

@@ -0,0 +1,4 @@
+Utilities
+=========
+
+.. automodule:: micarray.util