Installation Instructions

Note

This documentation includes several file:// links that usually point to files or directories in your source directory. When you are reading this documentation online, these links won’t work. Please read Generate this documentation on how to create this documentation including working file:// links.

Download

PalmveinRecLib

To have a stable version of the PalmveinRecLib, the safest option is to go to the PalmveinRecLib web page on PyPI and download the latest version.

Nevertheless, the library is also available as a project of Idiap at GitHub. To check out the current version of the PalmveinRecLib, go to the console, move to any place you like and call:

$ git clone git@github.com:bioidiap/palmveinreclib.git

Be aware that you will get the latest changes and that it might not work as expected.

Bob

The PalmveinRecLib is a satellite package of Bob, where most of the image processing, feature extraction, and palmvein recognition algorithms, as well as the evaluation techniques are implemented. This package uses FaceRecLib as a parent package. In its current version, the PalmveinRecLib requires Bob version 2 or greater. Since version 2.0 there is no need for a global installation of Bob any more, all required packages will be automatically downloaded from PyPi.

To install Packages of Bob, please read the Installation Instructions. For Bob to be able to work properly, some dependent packages are required to be installed. Please make sure that you have read the Dependencies for your operating system.

Note

Currently, running Bob under MS Windows in not yet supported. However, we found that running Bob in a virtual Unix environment such as the one provided by VirtualBox is a good alternative.

Usually, all possible database satellite packages (called bob.db.[...]) are automatically downloaded from PyPI. If you don’t want to download the databases, please edit the eggs section of the buildout.cfg configuration file by removing the databases that you don’t want.

The gridtk tool kit is mainly used for submitting submitting jobs to Idiap‘s SGE grid. The latest version also supports to run jobs in parallel on the local machine. You can safely remove this line from the buildout.cfg if you are not at Idiap and if you don’t want to launch your experiments in parallel.

Image Databases

With the PalmveinRecLib you will run palmvein recognition experiments using some default palm vein image databases. Though the verification protocols are implemented in the PalmveinRecLib, the images are not included. To download the image databases, please refer to the according Web-pages, database URL’s will be given in the Databases section.

Set-up your PalmveinRecLib

Now, you have everything ready so that you can continue to set up the PalmveinRecLib. To do this, we use the BuildOut system. To proceed, open a terminal in your FaceRecLib main directory and call:

$ python bootstrap-buildout.py
$ bin/buildout

The first step will generate a bin directory in the main directory of the PalmveinRecLib. The second step automatically downloads all dependencies of the PalmveinRecLib and creates all required scripts that we will need soon.

Test your Installation

One of the scripts that were generated during the bootstrap/buildout step is a test script. To verify your installation, you should run the script by calling:

$ bin/nosetests

In case any of the tests fail for unexplainable reasons, please file a bug report through the GitHub bug reporting system.

Note

Usually, all tests should pass with the latest stable versions of the Bob packages. In other versions, some of the tests may fail.

Generate this documentation

To generate this documentation, you call:

$ bin/sphinx-build docs sphinx

Afterwards, the documentation is available and you can read it, e.g., by using:

$ firefox sphinx/index.html