framework.tex 24.6 KB
 Simon Spannagel committed Jun 22, 2018 1 2 3 \chapter{The \corrybold Framework} \label{ch:framework}  Simon Spannagel committed Nov 29, 2019 4 5 6 7 \corry is based on a collection of modules read from a configuration file and an event loop which sequentially processes data from all detectors assigned to one event. In each loop iteration, all modules are executed in the linear order they appear in the configuration file and have access to all data created by previous modules. At the end of the loop iteration, the data cache is cleared and the framework continues with processing the next iteration. This chapter provides basic information about the different components of the framework, its executable as well as the available configuration parameters that are processed on a global level.  Simon Spannagel committed Jun 22, 2018 8 9 10  \section{The \texttt{corry} Executable} \label{sec:executable}  Simon Spannagel committed Nov 29, 2019 11 12 13 The \corry executable \command{corry} functions as the interface between the user and the framework. It is primarily used to provide the main configuration file, but also allows options from the main configuration file to be added or overwritten. This is useful for quick testing as well as for batch processing of many runs to be reconstructed.  Simon Spannagel committed Jun 22, 2018 14 15 16 17  The executable handles the following arguments: \begin{itemize} \item \texttt{-c }: Specifies the configuration file to be used for the reconstruction, relative to the current directory.  Simon Spannagel committed Nov 29, 2019 18 19 This is the only \textbf{required} argument and the program will fail to start if this argument is not given. \item \texttt{-l }: Specify an additional location, such as a file to forward log output into. This is used as an additional destination alongside the standard output and the location specified in the framework parameters described in Section~\ref{sec:framework_parameters}.  Simon Spannagel committed Jun 22, 2018 20 21 22 \item \texttt{-v }: Sets the global log verbosity level, overwriting the value specified in the configuration file described in Section~\ref{sec:framework_parameters}. Possible values are \texttt{FATAL}, \texttt{STATUS}, \texttt{ERROR}, \texttt{WARNING}, \texttt{INFO} and \texttt{DEBUG}, where all options are case-insensitive. The module specific logging level introduced in Section~\ref{sec:logging_verbosity} is not overwritten.  Simon Spannagel committed Nov 29, 2019 23 24 25 \item \texttt{-o