From e9a7976ee5a5c8c271c86aa6f6556e12f71222ec Mon Sep 17 00:00:00 2001
From: Steffen Hauf <steffen.hauf@desy.de>
Date: Wed, 27 Sep 2017 09:19:06 +0200
Subject: [PATCH] Update README.rst
---
README.rst | 26 ++++++++++++++++----------
1 file changed, 16 insertions(+), 10 deletions(-)
diff --git a/README.rst b/README.rst
index f0a6954ca..f781a0607 100644
--- a/README.rst
+++ b/README.rst
@@ -12,23 +12,25 @@ that node.
(optionally) Set up the environment::
- source setup_env.sh
-
-On Maxwell execution rights might be stripped. If you get
-an error for the above command, first run::
-
- chmod +x setup_env.sh
-
-If running headless, be sure to set `MPLBACKEND=Agg`, via::
+ module load python3
+ pip install --user ipython --upgrade
+ pip install --user ipyparallel --upgrade
+ pip install --user dill
+
+If running headless (i.e. without X forwarding), be sure to set
+`MPLBACKEND=Agg`, via::
export MPLBACKEND=Agg
-This is automatically done if you source the environment script.
+Then start an `ipcluster`. If you followed the steps above this can be done
+via::
+
+ ~/.local/bin/ipcluster start --n=32
Run the script::
- python calibrate.py --input /gpfs/exfel/exp/SPB/201701/p002012/raw/r0100 \
+ python3 calibrate.py --input /gpfs/exfel/exp/SPB/201701/p002012/raw/r0100 \
--output ../../test_out --mem-cells 30 --detector AGIPD --sequences 0,1
Here `--input` should point to a directory of `RAW` files for the detector you
@@ -39,6 +41,10 @@ for the run, as well as the `--detector`. Finally, you can optionally
specify to only process certain `--sequences` of files, matching the sequence
numbers of the `RAW` input. These should be given as a comma-separated list.
+Finally, there is a `--no-relgain` option, which disables relative gain
+correction. This can be useful while we still further characterize the detectors
+to provid accurate relative gain correction constants.
+
You'll get a series of plots in the output directory as well.
--
GitLab