README.rst 3.15 KB
Newer Older
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
1
2
3
4
.. vim: set fileencoding=utf-8 :
.. Tiago de Freitas Pereira <tiago.pereira@idiap.ch>
.. Mon 20 Jul 2015 16:57:00 CEST

5

6
.. image:: http://img.shields.io/badge/docs-stable-yellow.svg
7
   :target: http://pythonhosted.org/bob/index.html
8
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
9
   :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob/master/index.html
10
11
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/build.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
12
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
13
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
14
.. image:: http://img.shields.io/pypi/v/bob.svg
15
   :target: https://pypi.python.org/pypi/bob
16
.. image:: http://img.shields.io/pypi/dm/bob.svg
17
18
   :target: https://pypi.python.org/pypi/bob

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
19
====================
20
 Bob
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
21
22
23
24
25
26
27
28
29
30
====================

Bob is a free signal-processing and machine learning toolbox originally
developed by the Biometrics group at `Idiap`_ Research Institute, Switzerland.

The toolbox is written in a mix of `Python`_ and `C++`_ and is designed to be
both efficient and reduce development time. It is composed of a reasonably
large number of `packages`_ that implement tools for image, audio & video
processing, machine learning and pattern recognition.

31

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
32
33
34
Installation
------------

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
35
Follow our `installation`_ instructions. Then, using the Python interpreter
36
37
38
provided by the distribution, build this package with::

  $ buildout
39

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
40

41
42
For the maintainers
-------------------
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
43

44
In the next subsections we have instructions for the maintainers of the package.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
45

46

47
48
Adding a dependency package
===========================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
49

50
51
52

To add a package on bob, just append the package name in the file
(``requirements.txt``).
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
53
54

.. warning::
55

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
56
57
58
59
   Before adding a package to this prototype, please ensure that the package:

   * contains a README clearly indicating how to install the package (including
     external dependencies required). Also, please add package badges for the
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
60
     build status and coverage as shown in other packages.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
61
62
63

   * Has unit tests.

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
64
   * Is integrated with Gitlab-CI and correctly tests on that platform (i.e.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
65
66
67
68
69
70
71
     it builds, it tests fine and a documentation can be constructed and tested
     w/o errors)

   If you don't know how to do this, ask for information on the bob-devel
   mailing list.


72
73
Updating the dependencies
=========================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
74

75
76
77
78
79
80
If you want to update the version of the dependency packages, run the following
commands::

  $ ./bin/python ./bob/script/get_versions.py > requirements.txt
  $ git commit requirements.txt -m "Update requeriments" && git push

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
81

82
83
Removing a dependency package
=============================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
84

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
85
   To remove a package on bob, just remove the package name in the file ('requirements.txt').
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
86
87
88
89
90
91
92


.. External References

.. _c++: http://www2.research.att.com/~bs/C++.html
.. _python: http://www.python.org
.. _idiap: http://www.idiap.ch
93
94
95
96
97
.. _packages: https://www.idiap.ch/software/bob/packages
.. _wiki: https://www.idiap.ch/software/bob/wiki
.. _bug tracker: https://www.idiap.ch/software/bob/issues
.. _dependencies: https://gitlab.idiap.ch/bob/bob/wikis/Dependencies
.. _installation: https://www.idiap.ch/software/bob/install