Changeset f87e191 for doc/python_module.rst
- Timestamp:
- Nov 26, 2018, 10:33:30 PM (5 years ago)
- Branches:
- feature/constantq
- Children:
- 868c6b8
- Parents:
- d1d4ad4 (diff), db3eb5c (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the(diff)
links above to see all the changes relative to each parent. - File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/python_module.rst
rd1d4ad4 rf87e191 4 4 =========================== 5 5 6 The aubio extension for Python is available for Python 2.7 and Python 3. 6 aubio is available as a package for Python 2.7 and Python 3. The aubio 7 extension is written C using the `Python/C`_ and the `Numpy/C`_ APIs. 8 9 .. _Python/C: https://docs.python.org/c-api/index.html 10 .. _Numpy/C: https://docs.scipy.org/doc/numpy/reference/c-api.html 11 12 For general documentation on how to install Python packages, see `Installing 13 Packages`_. 7 14 8 15 Installing aubio with pip 9 16 ------------------------- 10 17 11 aubio can now be installedusing ``pip``:18 aubio can be installed from `PyPI`_ using ``pip``: 12 19 13 20 .. code-block:: console … … 15 22 $ pip install aubio 16 23 17 Building the module 18 ------------------- 24 See also `Installing from PyPI`_ for general documentation. 19 25 20 From ``aubio`` source directory, run the following: 26 .. note:: 27 28 aubio is currently a `source only`_ package, so you will need a compiler to 29 install it from `PyPI`_. See also `Installing aubio with conda`_ for 30 pre-compiled binaries. 31 32 .. _PyPI: https://pypi.python.org/pypi/aubio 33 .. _Installing Packages: https://packaging.python.org/tutorials/installing-packages/ 34 .. _Installing from PyPI: https://packaging.python.org/tutorials/installing-packages/#installing-from-pypi 35 .. _source only: https://packaging.python.org/tutorials/installing-packages/#source-distributions-vs-wheels 36 37 Installing aubio with conda 38 --------------------------- 39 40 `Conda packages`_ are available through the `conda-forge`_ channel for Linux, 41 macOS, and Windows: 21 42 22 43 .. code-block:: console 23 44 24 $ ./setup.py clean 25 $ ./setup.py build 26 $ sudo ./setup.py install 45 $ conda config --add channels conda-forge 46 $ conda install -c conda-forge aubio 27 47 48 .. _Conda packages: https://anaconda.org/conda-forge/aubio 49 .. _conda-forge: https://conda-forge.org/ 28 50 29 51 .. _py-doubleprecision: … … 68 90 ------------ 69 91 70 A number of `python tests`_ are provided. To run them, use 71 ``python/tests/run_all_tests``. 92 A number of Python tests are provided in the `python tests`_. To run them, 93 install `nose2`_ and run the script ``python/tests/run_all_tests``: 94 95 .. code-block:: console 96 97 $ pip install nose2 98 $ ./python/tests/run_all_tests 72 99 73 100 .. _demo_filter.py: https://github.com/aubio/aubio/blob/master/python/demos/demo_filter.py 74 101 .. _python tests: https://github.com/aubio/aubio/blob/master/python/tests 102 .. _nose2: https://github.com/nose-devs/nose2
Note: See TracChangeset
for help on using the changeset viewer.