README.rst 3.2 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
7
8

.. image:: http://img.shields.io/badge/docs-stable-yellow.png
   :target: http://pythonhosted.org/bob/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.png
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
15
16
17
18
.. image:: http://img.shields.io/pypi/v/bob.png
   :target: https://pypi.python.org/pypi/bob
.. image:: http://img.shields.io/pypi/dm/bob.png
   :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
36
Follow our `installation`_ instructions. Then, using the Python interpreter
provided by the distribution, bootstrap and buildout this package::
37
38

  $ python bootstrap-buildout.py
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
39
  $ ./bin/buildout
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
40
  
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
41

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

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

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

50
51
   
   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
52
53
54
55
56
57

.. warning::
   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
58
     build status and coverage as shown in other packages.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
59
60
61

   * Has unit tests.

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
62
   * Is integrated with Gitlab-CI and correctly tests on that platform (i.e.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
63
64
65
66
67
68
69
     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.


70
71
Updating the dependencies
=========================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
72

73
 If you want to update the version of the dependency packages, run the following commands::
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
74
 
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
75
 $ ./bin/python ./bob/script/get_versions.py > requirements.txt
76
 $ git commit requirements.txt -m "Update requeriments" && git push
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
77
78
 

79
80
Removing a dependency package
=============================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
81

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
82
   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
83
84
85
86
87
88
89
90
91
92
93


.. External References

.. _c++: http://www2.research.att.com/~bs/C++.html
.. _python: http://www.python.org
.. _idiap: http://www.idiap.ch
.. _packages: https://github.com/idiap/bob/wiki/Packages
.. _wiki: https://github.com/idiap/bob/wiki
.. _bug tracker: https://github.com/idiap/bob/issues
.. _dependencies: https://github.com/idiap/bob/wiki/Dependencies
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
94
.. _installation: https://gitlab.idiap.ch/bob/bob/wikis/Installation
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
95