Implement the NTuple::Writer and NTuple::GenericWriter algorithms for thread-safe NTuple writing

Overview

The NTuple writer is a Gaudi algorithm for writing data of any type from N locations in the event store to a TTree. It allows users to write data from various locations within the event store into a ROOT TTree structure dynamically creating branches leveraging ROOT's dynamic typing and I/O capabilities to support a range of data types based on either runtime or compile-time configurations.

Key Components

• NTuple::GenericWriter: This class represents an algorithm that dynamically creates branches based on runtime information. It is intended for scenarios where the exact configuration of the TTree branches is determined when configuring the Gaudi application itself. It allows users to specify N input data types and their corresponding locations in the event store to construct matching TTree branches.
• NTuple::Writer: This class represents a compile-time configured algorithm, inheriting from Gaudi::Functional::Consumer. It requires a transformation function to convert input data into a specific output format allowing it to deal with an arbitrary number of inputs and to also write to the file an arbitrary number of outputs. It relies on templates to define the structure and data transformations at compile time.

Workflow

• Initialization: Sets up the ROOT file and creates a TTree, initializing branches for each specified input.
• Execution: Fills the TTree with data from the event store.
• Finalization: Writes the filled TTree to the ROOT file and closes the file.

Key Features

• Supports dynamic branch creation based on runtime information.
• Offers compile-time optimized branch creation for predefined structures.
• Introduces a data transformation feature for more flexibility and control over what to write.
• Customizable configurations for file names and branch names.

Coverage

The merge request includes both pytest and Boost frameworks for unit and integration tests.

added 1 commit

• 830db431 - Remove unnecessary imports

Compare with previous version

resolved all threads

added 1 commit

• dfd497d6 - Remove unnecessary imports

Compare with previous version

resolved all threads

approved this merge request

added 4 commits

• 507a0c99 - Implement the NTuple::GenericWriter algorithm
• 301c7b5c - Add tests for the NTuple::GenericWriter algorithm
• dd1418dc - Implement the NTuple::Writer algorithm
• a86b0848 - Add tests for the NTuple::Writer algorithm

Compare with previous version

reset approvals from @sponce by pushing to the branch

added 2 commits

• 1804b20c - Move NTuple::GenericWriter tests to GaudiTestSuite
• c5ac4382 - Move NTuple::Writer tests to GaudiTestSuite

Compare with previous version

added 3 commits

• 9c4d57be - Delete unnecessary testing algorithms
• 56efac0f - Add NTUpleWriter testing algorithms
• 9d1b4cd2 - Update GenericNTupleWriter tests

Compare with previous version

added 2 commits

• 99443e43 - Add NTUpleWriter testing algorithms
• ea778fc8 - Update GenericNTupleWriter tests

Compare with previous version

changed milestone to %v38r2

added lhcb-gaudi-head label

assigned to @clemenci

• [2024-05-03 00:04] Automatic merge failed in [lhcb-gaudi-head#3898](https://lhcb-nightlies.web.cern.ch/nightly/lhcb-gaudi-head/3898/Gaudi/checkout
• [2024-05-03 00:19] Automatic merge failed in [lhcb-run2-gaudi-head#752](https://lhcb-nightlies.web.cern.ch/nightly/lhcb-run2-gaudi-head/752/Gaudi/checkout
• [2024-05-03 11:35] Validation started with lhcb-gaudi-head#3899
• [2024-05-04 00:04] Validation started with lhcb-gaudi-head#3900
• [2024-05-04 00:09] Validation started with lhcb-run2-gaudi-head#753
• [2024-05-04 00:37] Validation started with lhcb-gaudi-head#3900
• [2024-05-06 00:04] Validation started with lhcb-gaudi-head#3901
• [2024-05-06 00:19] Validation started with lhcb-run2-gaudi-head#754
• [2024-05-07 00:04] Validation started with lhcb-gaudi-head#3902
• [2024-05-07 00:08] Validation started with lhcb-run2-gaudi-head#755
• [2024-05-07 00:36] Validation started with lhcb-gaudi-head#3902