README.rst 2.23 KB
Newer Older
Amir MOHAMMADI's avatar
Amir MOHAMMADI committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
.. vim: set fileencoding=utf-8 :
.. Mon 03 Jul 2017 11:50:06 CEST

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


============================
Example buildout environment
============================

This package is part of the signal-processing and machine learning toolbox
Bob_. This simple example demonstrates how to wrap Bob-based scripts on buildout
environments. This may be useful for homework assignments, tests or as a way to
distribute code to reproduce your publication. In summary, if you need to give
out code to others, we recommend you do it following this template so your code
can be tested, documented and run in an orderly fashion.


Installation
------------

Follow our `installation`_ instructions. Then, using the Python interpreter
provided by the distribution, build this package with::

  $ buildout


Documentation and Further Information
-------------------------------------

Refer to the latest Bob_ documentation for details. In particular, the
guide `Bob Package Development`_ contains details on how to setup, build and
roll out your own code.


Contact
-------

For questions or reporting issues to this software package, contact our
development `mailing list`_.


.. Place your references here:
.. _bob: https://www.idiap.ch/software/bob
.. _installation: https://www.idiap.ch/software/bob/install
.. _mailing list: https://www.idiap.ch/software/bob/discuss
.. _bob package development: https://www.idiap.ch/software/bob/docs/bob/bob.extension/master/