how_it_works.rst

How it Works

The European XFEL Offline Calibration utilizes the tools nbconvert_ and nbparameterise to expose Jupyter notebooks to a command line interface. In the process reports are generated from these notebooks. The general interface is:

% xfel-calibrate DETECTOR TYPE

where DETECTOR and TYPE specify the task to be performed.

Additionally, it leverages the DESY/XFEL Maxwell cluster to run these jobs in parallel via SLURM.

Here is a list of :ref:`available_notebooks`. See the :ref:`advanced_topics` if you are for details on how to use as detector group staff.

If you would like to integrate additional notebooks please see the :ref:`development_workflow`.