Key4hep Tutorials

This page contains several tutorials for working in a Key4hep software stack. We try to design and set them up in a way that they can be done at any time but we present them at hands-on tutorial sessions as well. This is an incomplete list of all available tutorials, which you can find in the key4hep-tutorials repository.

If you are following these tutorials and run into an issue please let us know by opening an issue on the key4hep-doc repository. If you have the feeling that something is missing, we are also very happy to accept new tutorial suggestions. If you have a tutorial that you would like to add here.

Exercises

• Using the Key4hep-Stack for CLIC Simulation and Reconstruction
  • Simulation
  • Reconstruction
    • Reconstruction with Marlin
    • Reconstruction with Gaudi through k4MarlinWrapper
      • Reconstruction with LCIO input
      • Reconstruction with EDM4hep input
    • DD4hep Geometry Information
• Running ILD simulation and reconstruction
  • Setup
  • Running the simulation
  • Reconstruction
    • Using ILDReconstruction.py from ILDConfig
    • Creating a Gaudi options file
    • Adapting the options file for EDM4hep
    • Running the reconstruction with k4run
• Replacing an existing Marlin processor with a Gaudi algorithm
  • Pre-requisites
  • Setup
    • Input data
  • Running standard ILD full simulation and reconstruction
    • Simulation
    • Reconstruction
  • Writing a Gaudi algorithm
    • Setting up tutorial
    • Writing the Filter algorithm
      • Tasks
      • Installing and setting up the runtime environment
      • Hints and some common pitfalls
    • Using / testing the Filter algorithm
      • Tasks
      • Hints and some common pitfals
    • Writing the GammaGammaCandidateFinder algorithm
      • Tasks
      • Hints and common pitfalls
    • Pi0 / GammaGamma analysis
    • Replace wrapped processor with new algorithms
      • Hints and common pitfalls
• How to run multithreading with k4MarlinWrapper (Gaudi)
  • Running Gaudi with multithreading support
    • How to run with inter-event parallelism
  • Running example
• Running an Event Display with EDM4hep or LCIO input
  • Setting up an environment
  • Creating an input file
  • Running the event display
  • Details
  • Troubleshooting / Using other detectors
• Running Delphes fast simulation with EDM4hep output
  • Setup and prerequisites
  • Standalone executables
    • Other standalone executables
  • Usage in the Key4hep framework