doc/installing.rst

   1 Installing aubio
   2 ================
   3
   4 aubio runs on Linux, Windows, macOS, iOS, Android, and probably a few others
   5 operating systems.
   6
   7 Aubio is available as a C library and as a python module.
   8
   9 Cheat sheet
  10 -----------
  11
  12 - :ref:`get aubio latest source code <building>`::
  13
  14     # official repo
  15     git clone https://git.aubio.org/aubio/aubio
  16     # mirror
  17     git clone https://github.com/aubio/aubio
  18     # latest release
  19     wget https://aubio.org/pub/aubio-<version>.tar.gz
  20
  21
  22 - :ref:`build aubio from source <building>`::
  23
  24     # 1. simple
  25     cd aubio
  26     make
  27
  28     # 2. step by step
  29     ./scripts/get_waf.sh
  30     ./waf configure
  31     ./waf build
  32     sudo ./waf install
  33
  34 - :ref:`install python-aubio from source <python-install>`::
  35
  36     # from git
  37     pip install git+https://git.aubio.org/aubio/aubio/
  38     # mirror
  39     pip install git+https://github.com/aubio/aubio/
  40     # from latest release
  41     pip install https://aubio.org/pub/aubio-latest.tar.bz2
  42     # from pypi
  43     pip install aubio
  44     # from source directory
  45     cd aubio
  46     pip install -v .
  47
  48 - :ref:`install python-aubio from a pre-compiled binary <python-install>`::
  49
  50       # conda [osx, linux, win]
  51       conda install -c conda-forge aubio
  52       # .deb (debian, ubuntu) [linux]
  53       sudo apt-get install python3-aubio python-aubio aubio-tools
  54       # brew [osx]
  55       brew install aubio --with-python
  56
  57 - :ref:`get a pre-compiled version of libaubio <download>`::
  58
  59     # .deb (linux) WARNING: old version
  60     sudo apt-get install aubio-tools
  61
  62     # python module
  63     ./setup.py install
  64     # using pip
  65     pip install .
  66
  67 - :ref:`check the list of optional dependencies <requirements>`::
  68
  69     # debian / ubuntu
  70     dpkg -l libavcodec-dev libavutil-dev libavformat-dev \
  71             libswresample-dev libavresample-dev \
  72             libsamplerate-dev libsndfile-dev \
  73             txt2man doxygen
  74
  75 .. include:: download.rst
  76
  77 .. include:: building.rst
  78
  79 .. include:: requirements.rst