Commit f5d0dffc authored by Amir MOHAMMADI's avatar Amir MOHAMMADI

Improve readme

parent f761bc41
Pipeline #13854 failed with stages
in 5 minutes and 33 seconds
.. vim: set fileencoding=utf-8 :
.. Mon 03 Jul 2017 11:50:06 CEST
.. Tue Nov 7 16:30:33 CET 2017
.. 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://img.shields.io/badge/docs-stable-yellow.svg
:target: http://beatubulatest.lab.idiap.ch/private/docs/bob/bob.db.oulunpu/stable/index.html
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
:target: http://beatubulatest.lab.idiap.ch/private/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
.. image:: https://img.shields.io/pypi/v/bob.db.oulunpu.svg
:target: https://pypi.python.org/pypi/bob.db.oulunpu
============================
Example buildout environment
============================
=================================
OULU-NPU Database Access in Bob
=================================
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.
Bob_. This package provides an interface to the `OULU-NPU`_ database.
The original data files need to be downloaded separately.
If you use this database, please cite the following publication::
Installation
------------
Follow our `installation`_ instructions. Then, using the Python interpreter
provided by the distribution, build this package with::
@INPROCEEDINGS{OULU_NPU_2017,
author = {Boulkenafet, Z. and Komulainen, J. and Li, Lei. and Feng, X. and Hadid, A.},
keywords = {biometrics, face recognition, anti-spoofing, presentation attack, generalization, colour texture},
month = May,
title = {{OULU-NPU}: A mobile face presentation attack database with real-world variations},
journal = {IEEE International Conference on Automatic Face and Gesture Recognition},
year = {2017},
}
$ buildout
Installation
------------
Documentation and Further Information
-------------------------------------
Complete Bob's `installation`_ instructions. Then, to install this package,
run::
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.
$ conda install bob.db.oulunpu
Contact
......@@ -55,4 +55,4 @@ development `mailing list`_.
.. _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/
.. _oulu-npu: https://sites.google.com/site/oulunpudatabase/
......@@ -132,7 +132,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
short_description = u'Example for using Bob inside a buildout project'
short_description = u'OULU-NPU Database Access in Bob'
owner = [u'Idiap Research Institute']
......
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
# Andre Anjos <andre.anjos@idiap.ch>
# Mon 16 Apr 08:18:08 2012 CEST
#
# Copyright (C) Idiap Research Institute, Martigny, Switzerland
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# This file contains the python (distutils/setuptools) instructions so your
# package can be installed on **any** host system. It defines some basic
# information like the package name for instance, or its homepage.
#
# It also defines which other packages this python package depends on and that
# are required for this package's operation. The python subsystem will make
# sure all dependent packages are installed or will install them for you upon
# the installation of this package.
#
# The 'buildout' system we use here will go further and wrap this package in
# such a way to create an isolated python working environment. Buildout will
# make sure that dependencies which are not yet installed do get installed, but
# **without** requiring administrative privileges on the host system. This
# allows you to test your package with new python dependencies w/o requiring
# administrative interventions.
from setuptools import setup, dist
dist.Distribution(dict(setup_requires = ['bob.extension']))
......@@ -48,12 +15,12 @@ setup(
# information before releasing code publicly.
name = 'bob.db.oulunpu',
version = open("version.txt").read().rstrip(),
description = 'Example for using Bob inside a buildout project',
description = 'OULU-NPU Database Access in Bob',
url = 'https://github.com/<YourInstitution>/<YourPackage>',
url = 'https://gitlab.idiap.ch/bob/bob.db.oulunpu',
license = 'GPLv3',
author = '<YourName>',
author_email = '<YourEmail>',
author = 'Amir Mohammadi',
author_email = 'amir.mohammadi@idiap.ch',
keywords = 'bob',
# If you have a better, long description of your package, place it on the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment