Mercurial > hg > auditok
annotate doc/installation.rst @ 369:0106c4799906
Update documentation
| author | Amine Sehili <amine.sehili@gmail.com> |
|---|---|
| date | Sun, 10 Jan 2021 22:36:22 +0100 |
| parents | |
| children | c6308873f239 |
| rev | line source |
|---|---|
| amine@369 | 1 Installation |
| amine@369 | 2 ------------ |
| amine@369 | 3 |
| amine@369 | 4 .. code:: bash |
| amine@369 | 5 |
| amine@369 | 6 pip install auditok |
| amine@369 | 7 |
| amine@369 | 8 |
| amine@369 | 9 A basic version of ``auditok`` will run with standard Python (>=3.4). However, |
| amine@369 | 10 without installing additional dependencies, ``auditok`` can only deal with audio |
| amine@369 | 11 files in *wav* or *raw* formats. if you want more features, the following |
| amine@369 | 12 packages are needed: |
| amine@369 | 13 |
| amine@369 | 14 - `pydub <https://github.com/jiaaro/pydub>`_ : read audio files in popular |
| amine@369 | 15 audio formats (ogg, mp3, etc.) or extract audio from a video file. |
| amine@369 | 16 - `pyaudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ : read audio data |
| amine@369 | 17 from the microphone and play back detections. |
| amine@369 | 18 - `tqdm <https://github.com/tqdm/tqdm>`_ : show progress bar while playing |
| amine@369 | 19 audio clips. |
| amine@369 | 20 - `matplotlib <http://matplotlib.org/>`_ : plot audio signal and detections. |
| amine@369 | 21 - `numpy <http://www.numpy.org>`_ : required by matplotlib. Also used for |
| amine@369 | 22 some math operations instead of standard python if available. |