.. vim: set fileencoding=utf-8 :

.. _beat-installation:


===========================
 Installation Instructions
===========================

The BEAT framework is distributed as conda packages for Linux and MacOS.

#.  Install `conda`_ (miniconda is preferred) and get familiar with it.
#.  Make sure you have an up-to-date `conda`_ installation (conda 4.4 and above
    is needed) with the **correct configuration** by running the commands
    below:

    .. code:: sh

       $ conda update -n base conda
       $ conda config --set show_channel_urls True

#.  Create an environment for BEAT:

    .. code:: sh

       $ conda create --name beat \
         --override-channels \
         -c https://www.idiap.ch/software/beat/conda \
         -c defaults \
         python=3 beat.editor
       $ conda activate beat
       $ conda config --env --add channels defaults
       $ conda config --env --add channels https://www.idiap.ch/software/beat/conda

#.	Install other packages that you may need in this environment if you're running local tests.  For example:

    .. code:: sh

       $ conda install tensorflow opencv ...

#. The commands, ``beat`` and ``beat editor serve``, should be available.


.. tip::

   Repeat the last three steps for every conda environment that you create
   including BEAT components.


.. include:: links.rst