From e968618fa6844d93b5df54601456903ef2a50b4c Mon Sep 17 00:00:00 2001
From: Amir MOHAMMADI <amir.mohammadi@idiap.ch>
Date: Fri, 3 Jun 2022 15:39:01 +0200
Subject: [PATCH] Update installation instructions
---
doc/install.rst | 27 +++++++++++++++++++--------
1 file changed, 19 insertions(+), 8 deletions(-)
diff --git a/doc/install.rst b/doc/install.rst
index 7ae0d8f..888c9a4 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -56,10 +56,10 @@ Windows*.
#. Alternatively, you can use pip_ to install the packages but we don't test our pip packages:
- .. code:: sh
+.. code:: sh
- $ conda activate bob_env1
- $ pip install bob.bio.face ...
+ $ conda activate bob_env1
+ $ pip install bob.bio.face ...
For a comprehensive list of packages that are either part of |project| or use
|project|, please visit :ref:`bob.packages`.
@@ -85,6 +85,11 @@ For a comprehensive list of packages that are either part of |project| or use
https://stackoverflow.com/questions/50803148 for installations on how to
install Bob from source.
+.. note::
+
+ If you cannot install a Bob package, you might be trying to install an old
+ package. Please see :ref:`bob.install_old_versions` for instructions on how
+ to install old versions of Bob.
.. _bob.source:
@@ -104,6 +109,7 @@ your new code in a new package instead of modifying the original package.
environments. The only safe way to recover from this is to delete your Conda
installation completely and installing everything again from scratch.
+.. _bob.install_old_versions:
Installing older versions of Bob
================================
@@ -113,15 +119,20 @@ using conda. For example:
.. code:: sh
- $ mamba install \
+ $ mamba create -n old_bob_env \
+ --no-channel-priority \
-c https://www.idiap.ch/software/bob/conda \
-c defaults \
-c https://www.idiap.ch/software/bob/conda/label/archive \
- bob=4.0.0 bob.io.base
+ bob=4.0.0 bob.bio.face
+
+will install the version of ``bob.bio.face`` that was associated with the Bob
+4.0.0 release.
+
+.. note::
-will install the version of ``bob.io.base`` that was associated with the Bob
-4.0.0 release. Bob 9 and earlier used the ``defaults`` channel as base, for Bob
-10 and later replace ``defaults`` with ``conda-forge``.
+ Bob 9 and earlier used the ``defaults`` channel as base, for Bob 10 and
+ later replace ``defaults`` with ``conda-forge`` in the instructions above.
.. note::
--
GitLab