From d5ff08f6b469f902031158567cd2334b6abc4112 Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.anjos@idiap.ch>
Date: Fri, 19 Aug 2016 16:02:16 +0200
Subject: [PATCH] [doc] Add new installation section
---
doc/baselines.rst | 33 +--------------
doc/index.rst | 1 +
doc/installation.rst | 99 ++++++++++++++++++++++++++++++++++++++++++++
doc/links.rst | 4 ++
4 files changed, 105 insertions(+), 32 deletions(-)
create mode 100644 doc/installation.rst
diff --git a/doc/baselines.rst b/doc/baselines.rst
index 59cbedd..0c6aca0 100644
--- a/doc/baselines.rst
+++ b/doc/baselines.rst
@@ -11,38 +11,6 @@ The first thing you might want to do is to execute one of the vein
recognition algorithms that are implemented in ``bob.bio.vein``.
-Setting up Databases
---------------------
-
-In order to run vein recognition algorithms using this package, you'll need to
-make sure to download the raw files corresponding to the databases you'd like
-to process. The raw files are not distributed with Bob_ software as biometric
-data is, to most countries, considered sensible data that cannot be obtained
-without explicit licensing from a data controller. You must visit the websites
-below, sign the license agreements and then download the data before trying out
-to run the baselines.
-
-.. note::
-
- If you're at the Idiap Research Institute in Switzlerand, the datasets in
- the baselines mentioned in this guide are already downloaded and
- pre-installed on our shared file system. You don't need to re-download
- databases or create a ``~/.bob_bio_databases.txt`` file.
-
-
-The current system readily supports the following freely available datasets:
-
-* ``vera``: `Vera Fingervein`_
-* ``utfvp``: `UTFVP`_
-* ``put``: `PUT`_ Vein Dataset
-
-
-After downloading the databases, annotate the base directories in which they
-are installed. Then, follow the instructions in
-:ref:`bob.bio.base.installation` to let this framework know where databases are
-located on your system.
-
-
Running Baseline Experiments
----------------------------
@@ -221,6 +189,7 @@ Wide Line Detector None 10.4
WLD + HEQ (preproc) @ Vera/Full = 10.9%
+
Available Resources
-------------------
diff --git a/doc/index.rst b/doc/index.rst
index e660f3b..9c355cb 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -21,6 +21,7 @@ Users Guide
.. toctree::
:maxdepth: 2
+ installation
baselines
references
api
diff --git a/doc/installation.rst b/doc/installation.rst
new file mode 100644
index 0000000..aca91cd
--- /dev/null
+++ b/doc/installation.rst
@@ -0,0 +1,99 @@
+.. vim: set fileencoding=utf-8 :
+.. Fri 19 Aug 2016 15:03:52 CEST
+
+
+==============
+ Installation
+==============
+
+The installation of this package is divided in 2-parts. Installation of the
+package and its software dependencies and the installation of databases.
+
+
+Package Installation
+--------------------
+
+To install this package, first follow our `installation`_ instructions. Then,
+using the Python interpreter provided by the distribution, bootstrap and
+buildout this package:
+
+
+.. code-block:: sh
+
+ $ python bootstrap-buildout.py
+ $ ./bin/buildout
+
+
+Sphinx Documentation Building
+-----------------------------
+
+Once the package is installed, you may re-build this documentation locally by
+running:
+
+.. code-block:: sh
+
+ $ ./bin/sphinx-build doc html
+
+The resulting HTML documentation will be output inside the directory `html`.
+
+
+Setting up Databases
+--------------------
+
+In order to run vein recognition algorithms using this package, you'll need to
+make sure to download the raw files corresponding to the databases you'd like
+to process. The raw files are not distributed with Bob_ software as biometric
+data is, to most countries, considered sensible data that cannot be obtained
+without explicit licensing from a data controller. You must visit the websites
+below, sign the license agreements and then download the data before trying out
+to run the baselines.
+
+.. note::
+
+ If you're at the Idiap Research Institute in Switzlerand, the datasets in
+ the baselines mentioned in this guide are already downloaded and
+ pre-installed on our shared file system. You don't need to re-download
+ databases or create a ``~/.bob_bio_databases.txt`` file.
+
+
+The current system readily supports the following freely available datasets:
+
+* ``vera``: `Vera Fingervein`_
+* ``utfvp``: `UTFVP`_
+* ``put``: `PUT`_ Vein Dataset
+
+
+After downloading the databases, annotate the base directories in which they
+are installed. Then, follow the instructions in
+:ref:`bob.bio.base.installation` to let this framework know where databases are
+located on your system.
+
+
+Development
+-----------
+
+If you're developing this package, you may automatically clone all necessary
+Bob_ repositories on your local package installation. This allows you to build
+against an environment which contains all of our dependencies_, but no
+previously installed Bob_ packages. To do so, use the buildout recipe in
+``develop.cfg`` just after bootstraping:
+
+.. code-block:: sh
+
+ $ python bootstrap-buildout.py
+ $ ./bin/buildout -c develop.cfg
+
+
+Database SQL support files
+==========================
+
+If you installed all packages from scratch like above, you'll need to download
+the SQL support files of some of the database front-ends available in this
+package. This operation can be easily done like this:
+
+.. code-block:: sh
+
+ $ ./bin/bob_dbmanage.py all download
+
+
+.. include:: links.rst
diff --git a/doc/links.rst b/doc/links.rst
index 7838109..fb7aad0 100644
--- a/doc/links.rst
+++ b/doc/links.rst
@@ -22,3 +22,7 @@
.. _vera palmvein: https://www.idiap.ch/dataset/vera-palmvein
.. _utfvp: http://scs.ewi.utwente.nl/downloads/show,Finger%20Vein/
.. _put: http://biometrics.put.poznan.pl/vein-dataset/
+.. _installation: https://gitlab.idiap.ch/bob/bob/wikis/Installation
+.. _dependencies: https://gitlab.idiap.ch/bob/bob/wikis/Dependencies
+.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel
+.. _bob.bio.base: https://pythonhosted.org/bob.bio.base/
--
GitLab