.. European XFEL Offline Calibration documentation master file, created by sphinx-quickstart on Sun Jun 10 17:32:30 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. European XFEL Offline Calibration ================================= The European XFEL Offline Calibration (pyCalibration) is a python package that consists of different services, responsible for applying most of the offline calibration and characterization for the detectors. Running a calibration --------------------- It utilizes tools such as 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 looking for details on how to use as detector group staff. If you would like to integrate additional notebooks please see the :ref:`development_workflow`. .. _nbparameterise: https://github.com/takluyver/nbparameterise .. _nbconvert: https://github.com/jupyter/nbconvert .. _jupyter: http://jupyter.org/ .. _SLURM: https://slurm.schedmd.com Documentation contents: .. toctree:: :maxdepth: 2 installation configuration workflow available_notebooks advanced tutorial _notebooks/index testing .. toctree:: :caption: Reference :maxdepth: 2 xfel_calibrate_conf cal_tools_algorithms .. toctree:: :caption: Development :maxdepth: 2 changelog architecture Indices and tables ================== * :ref:`genindex` * :ref:`search`