Skip to content

Commit 59ac70c

Browse files
pkauswpkausw
authored
Merge pull request #1 from columnflow/chapters/introduction
Fill introduction of the documentation
2 parents 29ea4bc + 0de98cc commit 59ac70c

24 files changed

+281
-133
lines changed

‎.chktexrc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
# in the base directory of your project
3+
4+
QuoteStyle = Traditional
5+
6+
VerbEnvir
7+
{
8+
verbatim comment listing verbatimtab rawhtml errexam picture texdraw
9+
filecontents pgfpicture tikzpicture minted lstlisting texttt
10+
solution
11+
}
12+
13+
CmdLine
14+
{
15+
--nowarn 1 --nowarn 8 --nowarn 13
16+
}

‎.github/workflows/lint.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# in .github/workflows/lint.yml
2+
3+
name: Lint
4+
5+
on:
6+
push:
7+
branches:
8+
- main
9+
pull_request:
10+
branches:
11+
- main
12+
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@master
19+
- name: LaTeX linter (chktex)
20+
uses: j2kun/chktex-action@main
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@
99
*.xml
1010
*.DS_STORE
1111
*.txss2
12+
*.lof
13+
*.lot

‎.vscode/settings.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"workbench.colorCustomizations": {
3+
"activityBar.activeBackground": "#f181b2",
4+
"activityBar.background": "#f181b2",
5+
"activityBar.foreground": "#15202b",
6+
"activityBar.inactiveForeground": "#15202b99",
7+
"activityBarBadge.background": "#caf5a9",
8+
"activityBarBadge.foreground": "#15202b",
9+
"commandCenter.border": "#15202b99",
10+
"sash.hoverBorder": "#f181b2",
11+
"statusBar.background": "#ec5396",
12+
"statusBar.foreground": "#15202b",
13+
"statusBarItem.hoverBackground": "#e7257a",
14+
"statusBarItem.remoteBackground": "#ec5396",
15+
"statusBarItem.remoteForeground": "#15202b",
16+
"titleBar.activeBackground": "#ec5396",
17+
"titleBar.activeForeground": "#15202b",
18+
"titleBar.inactiveBackground": "#ec539699",
19+
"titleBar.inactiveForeground": "#15202b99"
20+
},
21+
"peacock.color": "#ec5396"
22+
}

‎chapters/exercise.tex‎

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,6 @@
1-
\chapter{$H \rightarrow ZZ \rightarrow 4l$}
2-
\justifying
3-
\paragraph{}
4-
The goal of this exercise is to reconstruct the Standard Model (SM) Higgs boson mass, using a selection targeting the four-lepton final state. This is considered a \textit{golden} channel to rediscovered the Higgs because:
5-
\begin{itemize}
6-
\item there is a \textbf{\underline{ large signal to background ratio}} -- it is easy to discriminate between the peak of the reconstructed four-lepton mass ($m_{4l}$) and the overall flat background shape;
7-
\item we have excellent \textbf{\underline{ mass resolution}} -- thanks to the great resolution power of CMS, we have optimal shape reconstruction of $m_{4l}$;
8-
\item it is a \textbf{\underline{ resolved final state}} -- detection of the four leptons in the final state ensures good discrimination of signal and background.
9-
\end{itemize}
10-
11-
\begin{figure}[!h]
12-
\centering
13-
\includegraphics[scale=0.35]{images/plot.png}
14-
\caption{\justifying{Reconstructed four-lepton invariant mass $m_{4l}$ with 2018 data. The SM Higgs boson signal with $m_H = 125$ GeV, denoted as $H(125)$, and the $ZZ$ backgrounds are normalized to the SM expectation. The $Z+X$ background is normalized to the estimation from data.}}
15-
\label{higgs_plot}
16-
\end{figure}
17-
18-
\include{sections/setup}
19-
\include{sections/strategy}
1+
\include{sections/taskarrayfunctions}
202
\include{sections/calibrator}
213
\include{sections/selector}
4+
\include{sections/producer}
5+
\include{sections/categorizer}
6+
\include{sections/inference}

‎chapters/intro.tex‎

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,5 @@
1-
\chapter{Introduction to ColumnFlow}
1+
\include{sections/general_intro}
2+
\include{sections/goal}
3+
\include{sections/setup}
4+
\include{sections/strategy}
25

3-
ColumnFlow is intended as a back-end for analyses in order to facilitate processing large amounts of data.
4-
It is purely python-based and employs multiple packages that are well-received and {-maintained} in the HEP community.
5-
At the time of writing these instructions, the team of developer's purely consists of data analysts at the CMS experiment.
6-
Therefore, this exercise is structured accordingly.
7-
Please note that ColumnFlow is in principle designed in an experiment-agnostic way, such that it can also be extended to other use cases.
8-
9-
Additionally, please note that this hands-on exercise is not meant to fully document all available functionalities.
10-
The purpose of this exercise is to give an overview of the most fundamental aspects and concepts that are available at the time of writing.
11-
For a more comprehensive overview, please visit the \href{https://columnflow.readthedocs.io/en/latest/}{official documentation}. % might want to put this as a proper reference
12-
In case of any questions are comments, feel free to contact the maintainers for example via the \href{https://github.com/columnflow/columnflow}{git repository}.
13-
14-
\begin{figure}[p]
15-
\centering
16-
\includegraphics[scale=0.8]{images/CF_tasks.png}
17-
\caption{\justifying{ColumnFlow task graph hierarchy}}
18-
\label{fig:task_graph}
19-
\end{figure}

‎images/CMS-HIG-19-001_Figure_004-a.pdf‎

130 Bytes
Binary file not shown.

‎images/QU_logo.jpg‎

Lines changed: 3 additions & 0 deletions
Loading

‎images/logos.png‎

Lines changed: 2 additions & 2 deletions
Loading

‎images/plot.png‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)