Commit c96190ea authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Manual: some small improvements, also updated parameter names in jobsub README

parent 80b382dc
Pipeline #639559 failed with stages
in 3 minutes and 13 seconds
......@@ -62,18 +62,21 @@ The internal base units of the framework are not chosen for user convenience but
& & ms (millisecond) \\
& & s (second) \\
\midrule
\multirow{3}{*}{\textit{Energy}} & \multirow{4}{*}{MeV (megaelectronvolt)} & eV (electronvolt) \\
\multirow{3}{*}{\textit{Energy}} & \multirow{3}{*}{MeV (megaelectronvolt)} & eV (electronvolt) \\
& & keV (kiloelectronvolt) \\
& & GeV (gigaelectronvolt) \\
\midrule
\textit{Temperature} & K (kelvin) & --- \\
\midrule
\multirow{2}{*}{\textit{Charge}} & e (elementary charge) & C (coulomb) \\
& & ke (kiloelectrons) \\
\multirow{3}{*}{\textit{Charge}} & \multirow{3}{*}{e (elementary charge)} & ke (kiloelectrons) \\
& & fC (femtocoulomb) \\
& & C (coulomb) \\
\midrule
\multirow{2}{*}{\textit{Voltage}} & \multirow{2}{*}{MV (megavolt)} & V (volt) \\
& & kV (kilovolt) \\
\midrule
\textit{Magnetic field strength} & T (tesla) & mT (millitesla) \\
\midrule
\multirow{2}{*}{\textit{Angle}} & \multirow{2}{*}{rad (radian)} & deg (degree) \\
& & mrad (milliradian) \\
\bottomrule
......@@ -197,7 +200,7 @@ All supported rotations are extrinsic active rotations, i.e. the vector itself i
\item A region of interest in the given detector can be defined using the \parameter{roi} parameter. More details on this functionality can be found in Section~\ref{sec:roi}.
\end{itemize}
An example configuration file describing a setup with one CLICpix2 detector (named \parameter{016_CP_PS} and two Timepix3~\cite{timepix} detectors (\parameter{W0013_D04}and \parameter{W0013_J05}) is the following:
An example configuration file describing a setup with one CLICpix2 detector named \parameter{016_CP_PS} and two Timepix3~\cite{timepix} detectors (\parameter{W0013_D04} and \parameter{W0013_J05}) is the following:
\begin{minted}[frame=single,framesep=3pt,breaklines=true,tabsize=2,linenos]{ini}
[W0013_D04]
......
......@@ -35,8 +35,9 @@ These are specified by adding a dot (\texttt{.}) between the detector and the ac
No interaction with the framework is possible during the reconstruction. Signals can however be send using keyboard shortcuts to terminate the run, either gracefully or with force. The executable understand the following signals:
\begin{itemize}
\item \texttt{CTRL+C} (SIGINT): Request a graceful shutdown of the reconstruction. This means the currently processed event is finished, while all other events requested in the configuration file are ignored. After finishing the event, the finalization stage is executed for every module to ensure all modules finish properly.
\item \texttt{CTRL+\textbackslash} (SIGQUIT): Forcefully terminates the framework. It is not recommended to use this signal as it will normally lead to the loss of all generated data. This signal should only be used when graceful termination is for any reason not possible.
\item SIGINT (\texttt{CTRL+C}): Request a graceful shutdown of the reconstruction. This means the currently processed event is finished, while all other events requested in the configuration file are ignored. After finishing the event, the finalization stage is executed for every module to ensure all modules finish properly.
\item SIGTERM: Same as SIGINT, request a graceful shutdown of the reconstruction. This signal is emitted e.g.\ by the \command{kill} command or by cluster computing schedulers to ask for a termination of the job.
\item SIGQUIT (\texttt{CTRL+\textbackslash}): Forcefully terminates the framework. It is not recommended to use this signal as it will normally lead to the loss of all generated data. This signal should only be used when graceful termination is for any reason not possible.
\end{itemize}
\section{The Clipboard}
......
......@@ -118,7 +118,7 @@ $ cmake -DCMAKE_INSTALL_PREFIX=../install/ \
\end{verbatim}
\subsection{Compilation and installation}
Compiling the framework is now a single command in the build folder created earlier (replacing \textit{\textless number\_of\_cores> \textgreater} with the number of cores to use for compilation):
Compiling the framework is now a single command in the build folder created earlier (replacing \textit{\textless number\_of\_cores\textgreater} with the number of cores to use for compilation):
\begin{verbatim}
$ make -j<number_of_cores>
\end{verbatim}
......
......@@ -71,11 +71,10 @@ The section of a configuration file template with variable geometry file and DUT
```toml
[Corryvreckan]
detectors_file = "@telescopeGeometry@"
histogramFile = "histograms_run@RunNumber@.root"
histogram_file = "histograms_run@RunNumber@.root"
number_of_events = 5000000
DUT = "@DUTName@"
log_level = WARNING
```
......@@ -84,11 +83,10 @@ When `jobsub` is executed, these placeholders are replaced with user-defined val
```toml
[Corryvreckan]
detectors_file = "my_telescope_Nov2017_1.conf"
histogramFile = "histograms_run999.root"
histogram_file = "histograms_run999.root"
number_of_events = 5000000
DUT = "W0019_G07"
log_level = WARNING
```
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment