Key4hep

Getting started

• Introduction
  • About
  • Notable stack components
  • License
  • Acknowledgements
• Getting help
• Getting key4hep
  • With CVMFS
• Contributing
  • Getting Started
  • Contributor Code of Conduct

Contents

• Key4hep How-Tos and Instructions
  • EDM4hep - The common event data model
    • Important resources
    • Reading EDM4hep files
    • Doxygen API documentation
  • podio - The technical infrastructure on which things run
    • podio code generation
    • The podio::Frame container
    • Reading EDM4hep files
    • ROOT file layout of podio generated EDMs
    • podio-dump
  • Reading and writing EDM4hep files in Gaudi
    • Accessing event data
    • Accessing metadata
    • Migrating from the legacy k4DataSvc
  • Adding custom arguments to k4run
  • Interactive python prompt
  • Getting algorithm run time information
    • AlgTimingAuditor
    • TimelineSvc
  • Wrapping Marlin processors in Gaudi
    • The MarlinProcessorWrapper Gaudi algorithm
    • Reading and writing LCIO events with Gaudi
    • Automatic conversion of Marlin XML steering files
    • Using the EDM converters
    • Tools for facilitating interoperability
    • Potential pitfalls when using other Gaudi Algorithms
  • Standalone conversion from LCIO to EDM4hep
    • Patching missing collections on the fly
    • Converting only a subset of collections
    • Renaming collections on the fly
  • Library usage of the conversion functions
    • Converting collection (data)
    • Handling relations
    • Handling of subset collections
    • Handling of LCRelations
    • Converting entire events
    • Converting Event parameters
    • Subtle differences between LCIO and EDM4hep
    • Example for a ReconstructedParticle Collection
• Key4hep Tutorials
  • Using the Key4hep-Stack for CLIC Simulation and Reconstruction
    • Simulation
    • Reconstruction
  • Running ILD simulation and reconstruction
    • Setup
    • Running the simulation
    • Reconstruction
  • Replacing an existing Marlin processor with a Gaudi algorithm
    • Pre-requisites
    • Setup
    • Running standard ILD full simulation and reconstruction
    • Writing a Gaudi algorithm
  • How to run multithreading with k4MarlinWrapper (Gaudi)
    • Running Gaudi with multithreading support
    • 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
    • Usage in the Key4hep framework
• Developing Key4hep
  • Github workflow and contribution guide
    • Overview
    • First time setup of git
    • Generate and set up ssh keys for github
    • Improving your git experience
    • Development workflow
    • Recommendations
    • Trouble-shooting
    • Need help?
  • Developing a single package
    • Building a local version
    • Adapt the environment with k4_local_repo
    • Adapt the environment manually
  • Building Key4hep using Spack: For Developers
    • Spack set up
    • Developing a single package
    • Developing multiple packages or dependencies of other packages
  • Writing Gaudi Algorithms
    • Gaudi
  • Gaudi::Functional
    • Setup
    • Walkthrough of Functional Algorithms
    • The steering file
    • Initialize and finalize
    • Debugging: How to use GDB
    • Avoiding const in operator()
  • Seeding algorithm PRNG
    • UniqueIDGenSvc service
    • Using UniqueIDGenSvc in algorithms
    • Seeding functional algorithm example
• Building Key4hep: For Librarians
  • Setting up Spack
    • Downloading a spack instance
    • Using Spack Environments
    • Using the key4hep-release-user environment
    • Configuring Spack
    • Configuring packages.yaml
• Talks and Presentations
• Call for logos

External links

• FCC software
• CLIC software
• ILC software
• CEPC software
• Muon Collider software