Commit cc25a86b authored by André Anjos's avatar André Anjos 💬
Browse files

Fix installation directives

parent 6ee4aa26
Pipeline #13185 passed with stages
in 20 minutes and 43 seconds
...@@ -14,26 +14,13 @@ Package Installation ...@@ -14,26 +14,13 @@ Package Installation
-------------------- --------------------
To install this package, first follow our `installation`_ instructions. Then, To install this package, first follow our `installation`_ instructions. Then,
using the Python interpreter provided by the distribution, bootstrap and using the Python interpreter provided by the distribution, install this
buildout this package: package:
.. code-block:: sh .. code-block:: sh
$ buildout $ conda install bob.bio.vein
Sphinx Documentation Building
-----------------------------
Once the package is installed, you may re-build this documentation locally by
running:
.. code-block:: sh
$ sphinx-build doc html
The resulting HTML documentation will be output inside the directory `html`.
Setting up Databases Setting up Databases
...@@ -51,21 +38,21 @@ to run the baselines. ...@@ -51,21 +38,21 @@ to run the baselines.
If you're at the Idiap Research Institute in Switzlerand, the datasets in If you're at the Idiap Research Institute in Switzlerand, the datasets in
the baselines mentioned in this guide are already downloaded and the baselines mentioned in this guide are already downloaded and
pre-installed on our shared file system. You don't need to re-download pre-installed on our shared file system.
databases or create a ``~/.bob_bio_databases.txt`` file.
The current system readily supports the following freely available datasets: The current system readily supports the following freely available datasets:
* ``vera``: `Vera Fingervein`_ * ``vera``: `Vera Fingervein`_
* ``utfvp``: `UTFVP`_ * ``utfvp``: `UTFVP`_
* ``fv3d``: `3D Fingervein`_
* ``put``: `PUT`_ Vein Dataset * ``put``: `PUT`_ Vein Dataset
After downloading the databases, annotate the base directories in which they After downloading the databases, annotate the base directories in which they
are installed. Then, follow the instructions in are installed. Then, follow the instructions in
:ref:`bob.bio.base.installation` to let this framework know where databases are :ref:`bob.bio.base.installation` to let this framework know where root
located on your system. installation of such databases are located on your system.
Development Development
...@@ -91,7 +78,7 @@ package. This operation can be easily done like this: ...@@ -91,7 +78,7 @@ package. This operation can be easily done like this:
.. code-block:: sh .. code-block:: sh
$ bob_dbmanage.py all download $ bob_dbmanage.py all download --missing
.. include:: links.rst .. include:: links.rst
Supports Markdown
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