From 89ba79b23119538476db8e5c99916cb448b70972 Mon Sep 17 00:00:00 2001 From: Karim Ahmed <karim.ahmed@xfel.eu> Date: Thu, 18 Jul 2019 12:04:02 +0200 Subject: [PATCH] note for target development installation --- docs/source/installation.rst | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 9113a1c29..38ef40719 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -94,22 +94,27 @@ then after cloning the offline calibration package from git, the requirements ca Development Installation ------------------------ -For a development installation, which automatically picks up (most) changes, -first install the dependencies as above, but then install the tool-chain -separately in development mode:: +For a development installation in your home directory, which automatically +picks up (most) changes, first install the dependencies as above, +but then install the tool-chain separately in development mode:: - pip install -e . + pip install -e . --user +.. note:: Using "- -target" for development installation in a preferred directory can lead to errors. + +.. note:: For development installation in karabo environment "- -user" is not needed. Installation of New Notebooks ----------------------------- -To install new, previously untracked notebooks repeat the installation of -the the tool-chain, without prerequisites, from the package base directory:: +To install new, previously untracked notebooks in the home directory, +repeat the installation of the the tool-chain, without requirments, +from the package base directory:: - pip install --upgrade . + pip install --upgrade . --user -Or, in case you are activily developing:: +Or, in case you are actively developing:: + + pip install -e . --user - pip install -e . -- GitLab