README.rst

Biometrics Evaluation and Testing Platform

This package contains the source code for the core components of the BEAT platform.

Installation

Really easy, with zc.buildout:

$ python bootstrap-buildout.py
$ ./bin/buildout

These 2 commands should download and install all non-installed dependencies and get you a fully operational test and development environment.

Note

The python shell used in the first line of the previous command set determines the python interpreter that will be used for all scripts developed inside this package.

If you are on the Idiap filesystem, you may use /idiap/project/beat/beat.env.deploy/usr/bin/python to bootstrap this package instead. It contains the same setup deployed at the final BEAT machinery.

Docker

This package depends on Docker and uses it to run user algorithms in a container with the required software stack. You must install the Docker engine and make sure the user running tests has access to it.

In particular, this package controls memory and CPU utilisation of the containers it launches. You must make sure to enable those functionalities on your installation.

Docker Setup

Make sure you have the docker command available on your system. For certain operating systems, it is necessary to install docker via an external virtual machine (a.k.a. the docker machine). Follow the instructions at the docker website <https://docs.docker.com/engine/installation/> before trying to execute algorithms or experiments.

We use specific docker images to run user algorithms. Download the following base images before you try to run tests or experiments on your computer:

$ docker pull docker.idiap.ch/beat/beat.env.system.python:1.1.2
$ docker pull docker.idiap.ch/beat/beat.env.db.examples:1.1.1
$ docker pull docker.idiap.ch/beat/beat.env.client:1.2.0
$ docker pull docker.idiap.ch/beat/beat.env.cxx:1.0.2

Optionally, also download the following images to be able to re-run experiments downloaded from the BEAT platform (not required for unit testing):

$ docker pull docker.idiap.ch/beat/beat.env.python:0.0.4
$ docker pull docker.idiap.ch/beat/beat.env.python:1.0.0
$ docker pull docker.idiap.ch/beat/beat.env.db:1.2.2