Welcome to k4megat documentation!

k4megat is the framework software for simulation, recostruction and analysis of Megat project. Megat is a space gamma spectrometer focusing on sub-MeV energy range.

Note

This project is still in its early stage, designning and prototyping. Everything is under active development. If wanna more details of the underlying Key4hep packags, read Dive-series

Contents

• 1 A Quick Tour
  • 1.1 Overview
  • 1.2 Write and run a job
  • 1.3 Write a new algorithm
    • 1.3.1 Configuration (Gaudi::Property)
    • 1.3.2 Event Data access
      • 1.3.2.1 input
      • 1.3.2.2 Output
    • 1.3.3 Service access
    • 1.3.4 Processing
    • 1.3.5 Component declaration
  • 1.4 Tutorial
• 2 Event Data Model
  • 2.1 What is saved in ROOT file
  • 2.2 TODO Future development
• 3 Geometry model
  • 3.1 Time Projection Chamber (TPC)
    • 3.1.1 Implementation details (DD4hep-related)
  • 3.2 CZT Calorimeter (Calo)
• 4 System of Units
• 5 Gaudi Internals
  • 5.1 Overview
    • 5.1.1 Algorithm
    • 5.1.2 Transient Event Store (TES)
    • 5.1.3 Service
    • 5.1.4 Tool
    • 5.1.5 Component-based programming
  • 5.2 Service Access
    • 5.2.1 General Service Access
      • 5.2.1.1 Method 1 (with ServiceHandle)
      • 5.2.1.2 Method 2 (with SmartIF)
    • 5.2.2 Default Service Access
  • 5.3 TODO Event Data Access
    • 5.3.1 Access Checklist
    • 5.3.2 Object Key
  • 5.4 Random number service
  • 5.5 RndmGenSv
    • 5.5.1 Use in Algorithm development
    • 5.5.2 Configuration in Job option
    • 5.5.3 List of engines
    • 5.5.4 List of generators
  • 5.6 Class diagram
• 6 Further reading
  • 6.1 Reference projects
    • 6.1.1 EIC
    • 6.1.2 FCC
  • 6.2 More about Gaudi
  • 6.3 Others
    • 6.3.1 Software management
    • 6.3.2 Modern C++