README.rst 2.88 KB
Newer Older
1
2
3
4
================
 BANCA Database
================

5
6

This package contains the access API and descriptions for the `BANCA English
7
Database <http://www.ee.surrey.ac.uk/CVSSP/banca/>`_. The actual raw data for
Manuel Günther's avatar
Manuel Günther committed
8
the database should be downloaded from the original URL. This API is only
9
compatible with the images from the BANCA English database.  This package only
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
contains the `Bob <http://www.idiap.ch/software/bob/>`_ accessor methods to use
the DB directly from python, with our certified protocols.

You would normally not install this package unless you are maintaining it. What
you would do instead is to tie it in at the package you need to **use** it.
There are a few ways to achieve this:

1. You can add this package as a requirement at the ``setup.py`` for your own
   `satellite package
   <https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_
   or to your Buildout ``.cfg`` file, if you prefer it that way. With this
   method, this package gets automatically downloaded and installed on your
   working environment, or

2. You can manually download and install this package using commands like
   ``easy_install`` or ``pip``.

The package is available in two different distribution formats:

1. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or

2. You can download it in its source form from `its git repository
Manuel Günther's avatar
Manuel Günther committed
32
   <https://github.com/bioidiap/bob.db.banca>`_. When you download the
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
   version at the git repository, you will need to run a command to recreate
   the backend SQLite file required for its operation. This means that the
   database raw files must be installed somewhere in this case. With option
   ``a`` you can run in `dummy` mode and only download the raw data files for
   the database once you are happy with your setup.

You can mix and match points 1/2 and a/b above based on your requirements. Here
are some examples:

Modify your setup.py and download from PyPI
===========================================

That is the easiest. Edit your ``setup.py`` in your satellite package and add
the following entry in the ``install_requires`` section (note: ``...`` means
`whatever extra stuff you may have in-between`, don't put that on your
script)::

    install_requires=[
      ...
Manuel Günther's avatar
Manuel Günther committed
52
      "bob.db.banca",
53
54
55
    ],

Proceed normally with your ``boostrap/buildout`` steps and you should be all
Manuel Günther's avatar
Manuel Günther committed
56
set. That means you can now import the ``bob.db.banca`` namespace into your scripts.
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

Modify your buildout.cfg and download from git
==============================================

You will need to add a dependence to `mr.developer
<http://pypi.python.org/pypi/mr.developer/>`_ to be able to install from our
git repositories. Your ``buildout.cfg`` file should contain the following
lines::

  [buildout]
  ...
  extensions = mr.developer
  auto-checkout = *
  eggs = bob
         ...
Manuel Günther's avatar
Manuel Günther committed
72
         bob.db.banca
73
74

  [sources]
Manuel Günther's avatar
Manuel Günther committed
75
  bob.db.banca = git https://github.com/bioidiap/bob.db.banca.git
76
  ...