Changeset e794a80


Ignore:
Timestamp:
Mar 6, 2014, 6:21:38 PM (7 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
1e18df6
Parents:
dc0e759
Message:

python/README: improve

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/README

    rdc0e759 re794a80  
    22===================
    33
    4 This module wraps the aubio library for python using the numpy module.
     4This module wraps the aubio library for Python using the numpy module.
    55
    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)
     6Before compiling this module, you must have compiled libaubio.
     7
     8For more information about how this module works, please refer to the [Python/C
     9API Reference Manual] (http://docs.python.org/c-api/index.html) and the
     10[Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).
    911
    1012Compiling python aubio
    1113----------------------
    1214
    13 You should be able to build the aubio python module out of the box:
     15After libaubio has been build successfully, and provided Python development
     16headers and numpy can be found on your system, you should be able to build the
     17aubio Python module:
    1418
    15     $ python setup.py build
     19    $ ./setup.py build
    1620
    17 To use the python module without installing it, set PYTHONPATH:
     21To find out more about `setup.py` options:
     22
     23    $ ./setup.py --help
     24
     25Installing
     26----------
     27
     28To install the Python module:
     29
     30    $ ./setup.py install
     31
     32Using the Python module
     33-----------------------
     34
     35Once the aubio library and the Python module are installed, you will be able to
     36import the aubio module:
     37
     38    $ python
     39    [...]
     40    >>> import aubio
     41    >>>
     42
     43Alternatively, you may want to use the Python module without installing it by
     44setting PYTHONPATH:
    1845
    1946    $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
    2047
    21 And LD_LIBRARY_PATH:
     48Similarly, you can use the aubio module without installing libaubio by pointing
     49LD_LIBRARY_PATH to the path libaubio can be found at:
    2250
    23     $ export LD_LIBRARY_PATH=$PWD/../build/src
     51    $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:PWD/../build/src
    2452
    25 Or on macosx systems:
     53Or on Mac OS X systems, setting DYLD_LIBRARY_PATH:
    2654
    27     $ export DYLD_LIBRARY_PATH=$PWD/../build/src
     55    $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/../build/src
    2856
    29 The you should be able to run the tests:
     57Testing the Python module
     58-------------------------
     59
     60Once both the C library and the Python module have been built correctly, and
     61after you have installed them (or setting the environment variable correctly),
     62you should be able to run the tests:
    3063
    3164    $ ./tests/run_all_tests
     
    3568    $ ./demos/demo_source.wav ~/test.wav
    3669
    37 Additional tools
    38 ----------------
    39 
    40 To use some of the demo scripts, you will need
    41 [matplotlib](http://matplotlib.org/).
     70You need to install additional modules to run some of the demos. For
     71instance, several demos use [matplotlib](http://matplotlib.org/) to draw plots.
     72Some more demos use [PySoundCard](https://github.com/bastibe/PySoundCard) to
     73play and record sounds.
Note: See TracChangeset for help on using the changeset viewer.