Installation and Configuration
=============================
1. log into max-exfl
2. install karabo in your home directory or under /gpfs/exfel/data/scratch/username: 
   wget http://exflserv05.desy.de/karabo/karaboFramework/tags/2.2.4/karabo-2.2.4-Release-CentOS-7-x86_64.sh
   chmod +x karabo-2.2.4-Release-CentOS-7-x86_64.sh
   ./karabo-2.2.4-Release-CentOS-7-x86_64.sh
   source karabo/activate 
3. get pycalibration
   git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
4. install requirements: 
   cd pycalibration
   pip install -r requirements.txt .
5. adjust xfel_calibrate/settings.py:
   change karabo_activate_path and ipcluster_path according to where you installed karabo

Create your own notebook
========================
1. Create a new notebook or re-arrange an existing on following the guidelines explained here: https://in.xfel.eu/readthedocs/docs/european-xfel-offline-calibration/en/latest/workflow.html

2. register you notebook:
   add an entry to xfel_calibrate/notebooks.py
   Note: use all capital letters for DETECTOR and TYPE
3. update:
   pip install --upgrade .


Running the notebook
====================
1. make sure output folders exist
2. run it: 
   xfel-calibrate Tutorial TEST
3. Look at generated report in output folder