python/README

   1 Python aubio module
   2 ===================
   3
   4 This module wraps the aubio library for python using the numpy module.
   5
   6 See the [Python/C API Reference
   7 Manual] (http://docs.python.org/c-api/index.html) and the [Numpy/C API
   8 Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html)
   9
  10 Compiling python aubio
  11 ----------------------
  12
  13 You should be able to build the aubio python module out of the box:
  14
  15     $ python setup.py build
  16
  17 To use the python module without installing it, set PYTHONPATH:
  18
  19     $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
  20
  21 And LD_LIBRARY_PATH:
  22
  23     $ export LD_LIBRARY_PATH=$PWD/../build/src
  24
  25 Or on macosx systems:
  26
  27     $ export DYLD_LIBRARY_PATH=$PWD/../build/src
  28
  29 The you should be able to run the tests:
  30
  31     $ ./tests/run_all_tests
  32
  33 And to try out the demos:
  34
  35     $ ./demos/demo_source.wav ~/test.wav
  36
  37 Additional tools
  38 ----------------
  39
  40 To use some of the demo scripts, you will need
  41 [matplotlib](http://matplotlib.org/).