Gaudi Developers Guide

Table of Contents

• 1. Introduction
  • 1.1. Purpose of this document
  • 1.2. The goal of Gaudi
  • 1.3. The spirit of the framework
  • 1.4. Structure of this guide
• 2. The framework architecture
  • 2.1. The big picture
  • 2.2. The main components
  • 2.3. Scheduling
  • 2.4. The functional framework
  • 2.5. Concurrency configuration at a glance
• 3. Getting started
  • 3.1. Job configuration: GaudiConfig2
  • 3.2. A first algorithm
  • 3.3. Running the job
  • 3.4. Job execution and multi-threading
• 4. Writing algorithms
  • 4.1. What changed
  • 4.2. The Gaudi::Algorithm base class
  • 4.3. The functional framework (prefered way)
  • 4.4. Control flow
• 5. Accessing data
  • 5.1. The transient event store
  • 5.2. Data handles
  • 5.3. Selections and ranges
  • 5.4. Detector conditions
  • 5.5. Persistency
• 6. Histograms and counters
  • 6.1. Counters
  • 6.2. Optimizing counter usage via buffers
  • 6.3. Histograms
  • 6.4. Persistency
  • 6.5. Legacy interfaces
• 7. NTuple and event collection facilities
  • 7.1. Gaudi::NTuple::Writer
  • 7.2. Gaudi::NTuple::SimpleWriter
  • 7.3. Gaudi::NTuple::Wrapper
  • 7.4. Opening the output file
  • 7.5. Event collections and persistency of event data
• 8. Framework services
  • 8.1. Using services: ServiceHandle
  • 8.2. Writing a service
  • 8.3. Properties
  • 8.4. The incident service
• 9. Tools and ToolSvc
  • 9.1. Using a tool in an algorithm: ToolHandle
  • 9.2. Tools as inputs of functional algorithms
  • 9.3. Writing a tool
  • 9.4. Tools of tools / tools of services
• 10. Logging and monitoring sinks
  • 10.1. Message logging
  • 10.2. Configuring sinks
  • 10.3. Writing a sink
• 11. Scripting and interactivity
  • 11.1. Running interactively with GaudiPython
  • 11.2. Python-written algorithms
  • 11.3. Auditors
• 12. Visualization facilities

API reference

The auto-generated API reference documentation is available in the Gaudi Doxygen pages.

Legacy guide

The previous version of this guide, describing many of the legacy interfaces that are still available for backward compatibility, is kept at Gaudi Developers Guide v9 (outdated) and can serve as a reference for older code.