Package: xbob.db.multipie
Multi-PIE DatabaseThis package contains the access API and descriptions for theMulti-PIE
Database. The actual raw data for
the database should be downloaded from the original URL. This package only
contains theBobaccessor 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 touseit.
There are a few ways to achieve this:You can add this package as a requirement at thesetup.pyfor your ownsatellite packageor to your Buildout.cfgfile, if you prefer it that way. With this
method, this package gets automatically downloaded and installed on your
working environment, orYou can manually download and install this package using commands likeeasy_installorpip.The package is available in two different distribution formats:You can download it fromPyPI, orYou can download it in its source form fromits git repository. When you download the
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 optionayou can run indummymode 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 PyPIThat is the easiest. Edit yoursetup.pyin your satellite package and add
the following entry in theinstall_requiressection (note:...meanswhatever extra stuff you may have in-between, don’t put that on your
script):install_requires=[
  ...
  "xbob.db.multipie",
],Proceed normally with yourboostrap/buildoutsteps and you should be all
set. That means you can now import thexbob.db.multipienamespace into your scripts.Modify your buildout.cfg and download from gitYou will need to add a dependence tomr.developerto be able to install from our
git repositories. Yourbuildout.cfgfile should contain the following
lines:[buildout]
...
extensions = mr.developer
auto-checkout = *
eggs = bob
       ...
       xbob.db.multipie

[sources]
xbob.db.multipie = git https://github.com/bioidiap/xbob.db.multipie.git
...Using protocolsFor simplicity, by default all provided protocols are enabled. This makes the
database query a bit slow. If you don’t want to wait each time you query the
database, you can re-create the database on your own. For that, you have to
follow the “download from git” recipe. After doing the bootstrap/buildout step
(seeherefor details) in your main directory, you have to go to the (newly created)
directorysrc/xbob.db.multipieand do the same bootstrap/buildout step
again. Finally, you can use theBobAPI:bin/bob_dbmanage.py multipie create--helpto regenerate the SQLite file
based on your criteria.Afterward, only the requested protocols should be available. If not, pleasefile a bugto get help.Note to the package maintainersOn PyPI, we used to provide the database with all the protocols enabled.
This means that the database has to be generated as follows, before the packaging:bin/bob_dbmanage.py multipie create-P-E.