WIP: instruction to install using anaconda

docs/source/conf.py

@@ -44,6 +44,8 @@ import sys
 import os
 from subprocess import Popen
 
+import sphinx_rtd_theme
+
 
 sys.path.append(os.path.abspath("../pycalibration/"))
 p = Popen(["./makeAllDocs.sh"])
@@ -137,7 +139,7 @@ todo_include_todos = True
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/installation.rst

@@ -2,20 +2,20 @@ Installation
 ============
 
 Installation of the European XFEL Offline Calibration tools is best
-done into a Karabo_ Python_ environment. However, there are no explicit
-Karabo dependencies, so any Python3 environment is capable of running
+done into an anaconda/3 or Karabo_ Python_ environment. However, there are no explicit
+dependencies, so any Python3 environment is capable of running
 the tools.
 
-A more detailed step-by-step intruction can be found in the :ref:`tutorial`.
+A more detailed step-by-step instruction can be found in the :ref:`tutorial`.
 
 Prerequisites
 -------------
 
 Prerequisites can be categorized into three types:
 
-1. those required to run the the general tool chain,
-2. those required by the notebooks themselves,
-3. and those required to run notebooks concurrently on a HPC cluster.
+1. Those required to run the the general tool chain,
+2. Those required by the notebooks themselves,
+3. Those required to run notebooks concurrently on a HPC cluster.
 
 Categories 1+2 are usually Python modules, as given in the `requirements.txt`
 file found in the root directory. Additionally, PyDetLib_ is required.
@@ -30,8 +30,8 @@ parameter when executing `xfel-calibrate`.
 .. _SLURM: https://slurm.schedmd.com
 .. _PyDetLib: https://in.xfel.eu/readthedocs/docs/pydetlib/en/latest/
 
-Installing
-----------
+Installing using Karabo
+-----------------------
 
 If you are installing into a Karabo environment make sure it is enabled
 by sourcing the activate file in the Karabo path::
@@ -47,7 +47,7 @@ You can then install all prerequisites and this tool chain by running::
 
     pip install -r requirements.txt .
     
-in th emain directoy pycalibration. 
+in pycalibration's root directory. 
 After installation, you should adjust the :ref:`configuration` and settings in the folder
 xfel-calibrate to match your environment.
 
@@ -57,6 +57,70 @@ The tool-chain is then available via the::
     
 command.
 
+Installing using Anaconda/3 in home directory
+---------------------------------------------
+
+If you are installing into anaconda environment make sure it is enabled
+by sourcing the activate file::
+
+    module load anaconda/3 
+
+For other python enviroments, this step can be skipped. The package for the offline
+calibration can be obtained from the git repository::
+
+    git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
+
+You can then install all requirements of this tool chain in your home directory by running::
+
+    pip install -r requirements.txt . --user
+
+in pycalibration's root directory.
+After installation, you should make sure the home directory is in the PATH environment variable::
+
+    PATH=~/.local/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.
+
+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 
+
+For other python enviroments, this step can be skipped. The package for the offline
+calibration can be obtained from the git repository::
+
+    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.
+
+
+
 Development Installation
 ------------------------
 

requirements.txt

@@ -15,5 +15,8 @@ gitpython
 karabo_data
 sklearn
 prettytable
+jupyter
+jupyter_console
+sphinx == 1.4.5
 ./cal_tools
 .