Changes in doc/python_module.rst [6d4802f:4583e75]

File:

• doc/python_module.rst (modified) (4 diffs)

doc/python_module.rst

@@ -1 @@
-.. _python-install:
+.. _python:
 
-Installing aubio for Python
-===========================
+Python module
+=============
 
 The aubio extension for Python is available for Python 2.7 and Python 3.
@@ -26 +26 @@
     $ sudo ./setup.py install
 
-
-.. _py-doubleprecision:
-
-Double precision
-----------------
-
-This module can be compiled in double-precision mode, in which case the
-default type for floating-point samples will be 64-bit. The default is
-single precision mode (32-bit, recommended).
-
-To build the aubio module with double precision, use the option
-`--enable-double` of the `build_ext` subcommand:
-
-.. code:: bash
-
-    $ ./setup.py clean
-    $ ./setup.py build_ext --enable-double
-    $ pip install -v .
-
-**Note**: If linking against `libaubio`, make sure the library was also
-compiled in :ref:`doubleprecision` mode.
-
-
-Checking your installation
---------------------------
+Using aubio in python
+---------------------
 
 Once the python module is installed, its version can be checked with:
@@ -64 +41 @@
     $ aubio -h
 
+A simple example
+................
+
+Here is a :download:`simple script <../python/demos/demo_source_simple.py>`
+that reads all the samples from a media file:
+
+.. literalinclude:: ../python/demos/demo_source_simple.py
+   :language: python
+
+Filtering an input sound file
+.............................
+
+Here is a more complete example, :download:`demo_filter.py
+<../python/demos/demo_filter.py>`. This files executes the following:
+
+* read an input media file (``aubio.source``)
+
+* filter it using an `A-weighting <https://en.wikipedia.org/wiki/A-weighting>`_
+  filter (``aubio.digital_filter``)
+
+* write result to a new file (``aubio.sink``)
+
+.. literalinclude:: ../python/demos/demo_filter.py
+   :language: python
+
+More demos
+..........
+
+Check out the `python demos folder`_ for more examples.
 
 Python tests
@@ -71 +77 @@
 ``python/tests/run_all_tests``.
 
+.. _python demos folder: https://github.com/aubio/aubio/blob/master/python/demos
 .. _demo_filter.py: https://github.com/aubio/aubio/blob/master/python/demos/demo_filter.py
 .. _python tests: https://github.com/aubio/aubio/blob/master/python/tests