amine@369: Installation
amine@369: ------------
amine@369: 
amine@432: **Dependencies**
amine@369: 
amine@432: The following dependencies are required by ``auditok`` and will be installed automatically:
amine@377: 
amine@432: - `numpy <https://numpy.org/>`_: Used for signal processing.
amine@432: - `pydub <https://github.com/jiaaro/pydub>`_: to read audio files in popular formats (e.g., ogg, mp3) or extract audio from video files.
amine@432: - `pyaudio <https://people.csail.mit.edu/hubert/pyaudio>`_: to read audio data from the microphone and play audio back.
amine@432: - `tqdm <https://github.com/tqdm/tqdm>`_: to display a progress bar while playing audio clips.
amine@432: - `matplotlib <https://matplotlib.org/stable/index.html>`_: to plot audio signal and detections.
amine@377: 
amine@432: ``auditok`` requires Python 3.7 or higher.
amine@432: 
amine@432: To install the latest stable version, use pip:
amine@377: 
amine@377: .. code:: bash
amine@377: 
amine@377:     sudo pip install auditok
amine@377: 
amine@432: To install the latest development version from GitHub:
amine@377: 
amine@377: .. code:: bash
amine@377: 
amine@377:     pip install git+https://github.com/amsehili/auditok
amine@377: 
amine@432: Alternatively, clone the repository and install it manually:
amine@377: 
amine@377: .. code:: bash
amine@377: 
amine@377:     git clone https://github.com/amsehili/auditok.git
amine@377:     cd auditok
amine@377:     python setup.py install