Skip to content
Snippets Groups Projects
Commit a6fb1fc3 authored by Mikhail Karnevskiy's avatar Mikhail Karnevskiy
Browse files

Merge branch 'doc/request_darks' into 'master'

Doc: Add description to request_dark script

See merge request detectors/pycalibration!64
parents 25b957ec d376e660
No related branches found
No related tags found
1 merge request!64Doc: Add description to request_dark script
......@@ -5,6 +5,32 @@ Advanced Topics
The following tasks should only be carried out by trained staff.
Request dark characterization
-----------------------------
The script runs dark characterization notebook with default parameters via web service. The data needs to be transferred via the MDC, however, the web service will wait for any transfer to be completed. The detector is chosen automatically with respect to given instrument (`--instrument`). For AGIPD, LPD, Jungfrau runs for the three gain stages need to be given (`--run-high`, `--run-med`, `--run-low`). For FastCCD and ePIX only a single run needs to be given (`--run`).
The complete list of parameters is::
-h, --help show this help message and exit
--proposal PROPOSAL The proposal number, without leading p, but with
leading zeros
--instrument {SPB,MID,FXE,SCS,SQS,HED}
The instrument
--cycle CYCLE The facility cycle
--run-high RUN_HIGH Run number of high gain data as an integer
--run-med RUN_MED Run number of medium gain data as an integer
--run-low RUN_LOW Run number of low gain data as an integer
--run RUN Run number as an integer
The path to data files is defined from script parameters. A typical data path, which can be found in the MDC is::
/gpfs/exfel/exp/MID/201930/p900071/raw
Where `MID` is an instrument name, `201930` is a cycle, `900071` is a proposal number.
Initiating Automated Offline Correction
---------------------------------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment