This repository contains instructions and documentation as well as potentially necessary (code) resources for several Key4hep tutorials. Each tutorial is aimed at being as standalone as possible, i.e., it should be possible to simply start any tutorial without having done any other before. Each tutorial is in its own subfolder in this repository.
-
introduction_key4hepPrerequisites, basic introduction and links to further documentation. -
whizard_gen- A tutorial that shows a simple example for generating events for the process$e^+e^- \rightarrow ZH$ with$Z\rightarrow \mu^+ \mu^-$ for the ILC at$E_{cms}=250$ GeV. -
gaudi_ild_reco- A tutorial that shows the full chain from simulation to reconstruction with the Gaudi based Key4hep framework using the ILD as example. -
gaudi_alg_higgs- A tutorial that shows how to create an algorithm to run with Gaudi to obtain the mass of the Higgs in a Higgs-recoil process. -
edm4hep_analylsis- Contains a small exercise that makes you use the basic components from podio and EDM4hep for writing small plotting scripts
The instructions are in markdown (md) format, but they might contain sphinx
specific tags since some of them are also included in the key4hep
website, where these allow for
a nicer rendering of additional information or the usage of more advanced
documentation features. These tags usually start with at least three colons
(':') and the most common one is probably
:::{dropdown} Some more text