[general][doc] rearanging the sections for documentation and added installation instruction
doc/beat/install.rst
0 → 100644
.. vim: set fileencoding=utf-8 : | ||
.. _beat-installation: | ||
============== | ||
Installation Instructions | ||
============== | ||
|
||
The BEAT is available as conda packages for linux and MacOS for locall usage. | ||
#. Please 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_py3 --override-channels \ | ||
-c https://www.idiap.ch/software/beat/conda -c defaults \ | ||
python=3 bob beat.core beat.cmdline beat.backend.python beat.editor | ||
$ conda activate beat_py3 | ||
$ conda config --env --add channels defaults | ||
$ conda config --env --add channels https://www.idiap.ch/software/bob/conda | ||
$ conda config --env --add channels https://www.idiap.ch/software/beat/conda | ||
#. Install other packages that you need in that environement: | ||
.. code:: sh | ||
$ conda install bob.ip.base bob.db.atnt .. | ||
#. The BEAT commands, ``beat`` and ``beat editor serve``, should be available. | ||
**Repeat the last three steps for every conda environment that you create for | ||
BEAT.** | ||
You are almost ready to design your experiment in BEAT. There are a few more requirements. | ||
Requirements | ||
------------ | ||
#. Working internet connection | ||
#. Firefox or Chrome browser | ||
#. Docker installed and available to the current user (not strictly necessary) | ||
-
Maintainer
André is correct to raise this one.
Have a look here https://gitlab.idiap.ch/beat/beat.core/blob/master/doc/algorithms.rst
There's this one extra
=
at the end up and down for double-sided titles for the "Algorithms" titleDon't forget to add them. It was nightmare adding them on all beat.* packages when I started working on this
doc
package to make sure sphinx doesn't have any issue with the doc generation...Good luck
👍🏻 -
Author Maintainer
Thanks for letting me know.