From fe96b9cf08167b20947dfa507dd4ee779d8a4407 Mon Sep 17 00:00:00 2001
From: Karim Ahmed <karim.ahmed@xfel.eu>
Date: Mon, 15 Jul 2019 13:53:36 +0200
Subject: [PATCH] installation doc modifications
---
docs/source/installation.rst | 93 ++++++++++++------------------------
1 file changed, 31 insertions(+), 62 deletions(-)
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index 9a01281ea..1b81f4049 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -30,57 +30,47 @@ parameter when executing `xfel-calibrate`.
.. _SLURM: https://slurm.schedmd.com
.. _PyDetLib: https://in.xfel.eu/readthedocs/docs/pydetlib/en/latest/
-Installing using Karabo
------------------------
+Installing using Anaconda
+---------------------------
-If you are installing into a Karabo environment make sure it is enabled
-by sourcing the activate file in the Karabo path::
+First you need to load the anaconda/3 environment through::
- source karabo/activate
-
-For other python enviroments, this step can be skipped. The package for the offline
-calibration can be obtained from the git repository::
+ 1. module load anaconda/3
- git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
+If installing into other python enviroments, this step can be skipped.
-You can then install all prerequisites and this tool chain by running::
+Then the package for the offline calibration can be obtained from the git repository::
- pip install -r requirements.txt .
-
-in pycalibration's root directory.
-After installation, you should adjust the :ref:`configuration` and settings in the folder
-xfel-calibrate to match your environment.
+ 2. git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
-The tool-chain is then available via the::
+Home directory
+++++++++++++++
- xfel-calibrate
-
-command.
+You can then install all requirements of this tool chain in your home directory by running::
-Installing using Anaconda/3 in home directory
----------------------------------------------
+ 3. pip install -r requirements.txt . --user
-If you are installing into anaconda environment make sure it is enabled
-by sourcing the activate file::
+in pycalibration's root directory.
- module load anaconda/3
+After installation, you should make sure that the home directory is in the PATH environment variable::
-For other python enviroments, this step can be skipped. The package for the offline
-calibration can be obtained from the git repository::
+ 4. PATH=/home/<username>/.local/bin:$PATH
- git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
+Preferred directory
++++++++++++++++++++
-You can then install all requirements of this tool chain in your home directory by running::
+Alternatively, you can install all requirements in a directory of your preference by::
- pip install -r requirements.txt . --user
+ 3. mkdir /gpfs/exfel/data/scratch/<username>/<directory-name>
+ pip install --target=/gpfs/exfel/data/scratch/<username>/<directory-name> -r requirements.txt .
-in pycalibration's root directory.
-After installation, you should make sure the home directory is in the PATH environment variable::
+and it is important to make sure that installed requirements is in the PATH environment::
+
+ 4. PATH=/gpfs/exfel/data/scratch/<username>/<directory-name>/bin:$PATH
- PATH=~/.local/bin:$PATH
-and adjust the :ref:`configuration` and settings in the folder
-xfel-calibrate to match your environment.
+After this make sure to adjust the :ref:`configuration` and settings in the xfel-calibrate
+folder to match your environment.
The tool-chain is then available via the::
@@ -88,38 +78,18 @@ The tool-chain is then available via the::
command.
-Installing using Anaconda/3 in preferred directory
---------------------------------------------------
-
-If you are installing into anaconda environment make sure it is enabled
-by sourcing the activate file::
- module load anaconda/3
+Install into karabo
++++++++++++++++++++
-For other python enviroments, this step can be skipped. The package for the offline
-calibration can be obtained from the git repository::
+If required, one can install into karabo environment. The difference would be to
+first source activate the karabo envrionment::
- git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
-
-You can then install all requirements of this tool chain in your preferred directory by running::
-
- pip install --target=~/myscratch/directory -r requirements.txt .
-
-in pycalibration's root directory.
-After installation, you should make sure the your preferred directory is in the PATH environment variable::
-
- PATH=~/myscratch/directory/bin:$PATH
-
-and adjust the :ref:`configuration` and settings in the folder
-xfel-calibrate to match your environment.
-
-The tool-chain is then available via the::
-
- xfel-calibrate
-
-command.
+ 1. source karabo/activate
+then after cloning the offline calibration package from git, the requirements can be installed through::
+ 3. pip install -r requirements.txt .
Development Installation
------------------------
@@ -129,7 +99,6 @@ first install the dependencies as above, but then install the tool-chain
separately in development mode::
pip install -e .
-
Installation of New Notebooks
--
GitLab