From ee7d4f96a0201d7f2265519b6a5603c3102c602a Mon Sep 17 00:00:00 2001
From: Amir MOHAMMADI <amir.mohammadi@idiap.ch>
Date: Tue, 31 May 2022 13:47:52 +0200
Subject: [PATCH] update installation instructions and mamba/boa versions
---
bob/devtools/bootstrap.py | 4 ++--
conda/meta.yaml | 4 ++--
doc/development.rst | 7 +++++++
doc/install.rst | 21 +++++++++++++--------
4 files changed, 24 insertions(+), 12 deletions(-)
diff --git a/bob/devtools/bootstrap.py b/bob/devtools/bootstrap.py
index bfb79ed6..be3d3d1c 100644
--- a/bob/devtools/bootstrap.py
+++ b/bob/devtools/bootstrap.py
@@ -527,8 +527,8 @@ if __name__ == "__main__":
conda_version = "4"
conda_build_version = "3"
- mamba_version = "0.21"
- boa_version = "0.9"
+ mamba_version = "0.23"
+ boa_version = "0.11"
conda_verbosity = []
# if args.verbose >= 2:
diff --git a/conda/meta.yaml b/conda/meta.yaml
index cbeef839..a4506c41 100644
--- a/conda/meta.yaml
+++ b/conda/meta.yaml
@@ -33,8 +33,8 @@ requirements:
- click-plugins
- conda=4
- conda-build=3
- - mamba=0.21
- - boa=0.9
+ - mamba=0.23
+ - boa=0.11
- certifi
- docformatter
- git # [linux]
diff --git a/doc/development.rst b/doc/development.rst
index 9dfb237c..4b4b4eb3 100644
--- a/doc/development.rst
+++ b/doc/development.rst
@@ -36,6 +36,13 @@ assume you have ``bob.devtools`` installed on a conda environment named ``bdt``
$ bdt dev create -vv dev
$ conda activate dev
+.. note::
+
+ ``bdt`` might try to install the cuda version of deep learning packages. If
+ you don't have cuda drivers installed and face errors such as ``nothing
+ provides __cuda``, you might need to run: ``export CONDA_OVERRIDE_CUDA=11.6``
+ where instead of ``11.6`` you should put the latest version of cuda.
+
* Build the package using pip:
.. code-block:: sh
diff --git a/doc/install.rst b/doc/install.rst
index 9ad78842..9dec0d02 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -28,17 +28,21 @@ We provide packages for both 64-bit Linux and MacOS, for Python 3.8+.
recommend you install this package on the ``base`` environment.
Installing bob.devtools will create a terminal command called ``bdt`` which you
-must create an alias for it because some ``bdt`` commands require another conda
+must make available in your ``PATH`` because some ``bdt`` commands require another conda
environment to be activated. Moreover, development of Bob packages depend on
pre-commit_ (pre-commit gets installed as a dependency of bob.devtools) so you
-will need an alias for that as well:
+will need to make that available in your ``PATH`` environment variable as well:
.. code-block:: sh
+ # Make sure bdt and pre-commit are available in your PATH
+ $ mkdir -pv $HOME/.local/bin
+ $ export PATH=$HOME/.local/bin:$PATH
$ conda activate base
- $ echo "alias bdt=$(which bdt)" >> ~/.bashrc
- # you will also need pre-commit which gets installed when you install bob.devtools
- $ echo "alias pre-commit=$(which pre-commit)" >> ~/.bashrc
+ $ ln -s $(command -v bdt) $HOME/.local/bin/
+ $ ln -s $(command -v pre-commit) $HOME/.local/bin/
+ # Make sure $HOME/.local/bin is in your PATH all the time.
+ $ echo 'export PATH=$HOME/.local/bin:$PATH' >> $HOME/.bashrc
$ source ~/.bashrc
# test if it works
$ conda deactivate
@@ -96,10 +100,11 @@ pip-installable packages, create a section named ``create`` in the file
.. code-block:: ini
[create]
- pip_extras = pre-commit
+ pip_extras = ipdb
+ ipdbplugin
-Then, by default, ``bdt dev create`` will automatically pip install
-``pre-commit`` at environment creation time. You may reset this list to your
+Then, by default, ``bdt dev create`` will automatically pip install ``ipdb`` and
+``ipdbplugin`` at environment creation time. You may reset this list to your
liking.
.. include:: links.rst
--
GitLab