README.rst 2.63 KB
Newer Older
Artur Costa Pazo's avatar
Artur Costa Pazo committed
1
2
3
4
.. vim: set fileencoding=utf-8 :
.. Manuel Guenther <manuel.guenther@idiap.ch>
.. Fri Oct 31 14:18:57 CET 2014

5
6
.. TODO: Should be checked

Artur Costa Pazo's avatar
Artur Costa Pazo committed
7
.. image:: http://img.shields.io/badge/docs-stable-yellow.png
8
   :target: http://pythonhosted.org/bob.db.replaymobile/index.html
Artur Costa Pazo's avatar
Artur Costa Pazo committed
9
.. image:: http://img.shields.io/badge/docs-latest-orange.png
10
   :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.db.replaymobile/master/index.html
Artur Costa Pazo's avatar
Artur Costa Pazo committed
11
.. image:: https://travis-ci.org/bioidiap/bob.db.replay.svg?branch=master
12
   :target: https://travis-ci.org/bioidiap/bob.db.replaymobile
Artur Costa Pazo's avatar
Artur Costa Pazo committed
13
.. image:: https://coveralls.io/repos/bioidiap/bob.db.replay/badge.png
14
   :target: https://coveralls.io/r/bioidiap/bob.db.replaymobile
Artur Costa Pazo's avatar
Artur Costa Pazo committed
15
.. image:: https://img.shields.io/badge/github-master-0000c0.png
16
   :target: https://github.com/bioidiap/bob.db.replaymobile/tree/master
Artur Costa Pazo's avatar
Artur Costa Pazo committed
17
.. image:: http://img.shields.io/pypi/v/bob.db.replay.png
18
   :target: https://pypi.python.org/pypi/bob.db.replaymobile
Artur Costa Pazo's avatar
Artur Costa Pazo committed
19
.. image:: http://img.shields.io/pypi/dm/bob.db.replay.png
20
   :target: https://pypi.python.org/pypi/bob.db.replaymobile
Artur Costa Pazo's avatar
Artur Costa Pazo committed
21
.. image:: https://img.shields.io/badge/original-data--files-a000a0.png
22
   :target: http://www.idiap.ch/dataset/replaymobile
Artur Costa Pazo's avatar
Artur Costa Pazo committed
23
24

===================================================
25
 Replay Mobile Database Interface for Bob
Artur Costa Pazo's avatar
Artur Costa Pazo committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
===================================================

This package contains the access API and descriptions for the `Replay Mobile`_ Database.
The actual raw data for the database should be downloaded from the original URL.
This package only contains the Bob_ accessor methods to use the database directly from Python, with our certified protocols.


Installation
------------
To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_.
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 <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system.

Documentation
-------------
For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.db.replay/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.db.replay/master/index.html>`_ of the documentation.
For a list of tutorials on this or the other packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website.

.. _bob: https://www.idiap.ch/software/bob
.. _replay mobile: http://www.idiap.ch/dataset/replaymobile