Changeset e794a80

Timestamp:

Mar 6, 2014, 6:21:38 PM (10 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

1e18df6

Parents:

dc0e759

Message:

python/README: improve

File:

• python/README (modified) (2 diffs)

python/README

@@ -2 +2 @@
 ===================
 
-This module wraps the aubio library for python using the numpy module.
+This module wraps the aubio library for Python using the numpy module.
 
-See the [Python/C API Reference
-Manual] (http://docs.python.org/c-api/index.html) and the [Numpy/C API
-Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html)
+Before compiling this module, you must have compiled libaubio.
+
+For more information about how this module works, please refer to the [Python/C
+API Reference Manual] (http://docs.python.org/c-api/index.html) and the
+[Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).
 
 Compiling python aubio
 ----------------------
 
-You should be able to build the aubio python module out of the box:
+After libaubio has been build successfully, and provided Python development
+headers and numpy can be found on your system, you should be able to build the
+aubio Python module:
 
-    $ python setup.py build
+    $ ./setup.py build
 
-To use the python module without installing it, set PYTHONPATH:
+To find out more about `setup.py` options:
+
+    $ ./setup.py --help
+
+Installing
+----------
+
+To install the Python module:
+
+    $ ./setup.py install
+
+Using the Python module
+-----------------------
+
+Once the aubio library and the Python module are installed, you will be able to
+import the aubio module:
+
+    $ python
+    [...]
+    >>> import aubio
+    >>>
+
+Alternatively, you may want to use the Python module without installing it by
+setting PYTHONPATH:
 
     $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
 
-And LD_LIBRARY_PATH:
+Similarly, you can use the aubio module without installing libaubio by pointing
+LD_LIBRARY_PATH to the path libaubio can be found at:
 
-    $ export LD_LIBRARY_PATH=$PWD/../build/src
+    $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:PWD/../build/src
 
-Or on macosx systems:
+Or on Mac OS X systems, setting DYLD_LIBRARY_PATH:
 
-    $ export DYLD_LIBRARY_PATH=$PWD/../build/src
+    $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/../build/src
 
-The you should be able to run the tests:
+Testing the Python module
+-------------------------
+
+Once both the C library and the Python module have been built correctly, and
+after you have installed them (or setting the environment variable correctly),
+you should be able to run the tests:
 
     $ ./tests/run_all_tests
@@ -35 +68 @@
     $ ./demos/demo_source.wav ~/test.wav
 
-Additional tools
-----------------
-
-To use some of the demo scripts, you will need
-[matplotlib](http://matplotlib.org/).
+You need to install additional modules to run some of the demos. For
+instance, several demos use [matplotlib](http://matplotlib.org/) to draw plots.
+Some more demos use [PySoundCard](https://github.com/bastibe/PySoundCard) to
+play and record sounds.