README.rst

.. vim: set fileencoding=utf-8 :

.. image:: http://img.shields.io/badge/docs-stable-yellow.svg
   :target: http://pythonhosted.org/bob/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
   :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob/master/index.html
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/build.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
.. image:: https://gitlab.idiap.ch/bob/bob/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/bob/bob/commits/master
.. image:: http://img.shields.io/pypi/v/bob.svg
   :target: https://pypi.python.org/pypi/bob
.. image:: http://img.shields.io/pypi/dm/bob.svg
   :target: https://pypi.python.org/pypi/bob

====================
 Bob
====================

Bob is a free signal-processing and machine learning toolbox originally
developed by the Biometrics group at the `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 & pattern recognition, and a lot more task
specific packages.

**Please visit our `website`_ for more information.**


For the maintainers
-------------------

Below are some instructions for the maintainers of the package.


Updating the dependencies
=========================

If you want to update the version of the dependency packages, run the following
commands::

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


Removing a dependency package
=============================

To remove a package on bob, just remove the package name in the file
(`requirements.txt`).


.. External References

.. _c++: http://www2.research.att.com/~bs/C++.html
.. _python: http://www.python.org
.. _idiap: http://www.idiap.ch
.. _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
.. _installation: https://www.idiap.ch/software/bob/install
.. _website: https://www.idiap.ch/software/bob