.. -*- coding: utf-8 -*-

.. _bob.bio.demographics.setup:

=======
 Setup
=======

Complete Bob's installation instructions. Then, to install this package, do
this:

.. code-block:: sh

   $ conda activate <myenv>
   (<myenv>) $ conda install bob.bio.demographics

.. note::

   The value ``<myenv>`` should correspond to the name of the environment where
   you initially installed your Bob packages.


Datasets
--------

General rules
.............
   
   The package supports a range of face recognition datasets, but does not include
   the raw data itself
   
   To setup a dataset, do the following:
   
   1. Download the dataset from the authors website.
   
   2.  For each dataset that you are going to use, set the ``directory`` to the
       root path where it is stored.  E.g.:
   
       .. code-block:: sh
   
          (<myenv>) $ bob config set bob.bio.face.rfw.directory "/path/to/rfw"


Supported datasets
..................

Follow the instructions below to set each of one of the supported datasets

Racial Faces in the Wild (RFW)
******************************

.. code-block:: sh
   
   (<myenv>) $ bob config set bob.bio.face.rfw.directory "/path/to/rfw"


Multiple Encounter Dataset II (MEDS II)
***************************************
   
   .. code-block:: sh
      
      (<myenv>) $ bob config set bob.bio.face.meds.directory "/path/to/meds"
   

MORPH dataset 
*************
   
   .. code-block:: sh
      
      (<myenv>) $ bob config set bob.bio.face.morph.directory "/path/to/morph"
      
MOBIO dataset 
*************
   
   .. code-block:: sh
      
      (<myenv>) $ bob config set bob.bio.face.mobio.directory "/path/to/mobio"
      

Casia Africa Dataset 
********************
   
   .. code-block:: sh
      
      (<myenv>) $ bob config set bob.bio.face.casia-africa.directory "/path/to/casia-africa"