root icon indicating copy to clipboard operation
root copied to clipboard

[ntuple] Provide tutorial for (envisioned) framework usage

Open hahnjo opened this issue 1 year ago • 0 comments

It would be good to provide a tutorial how we (RNTuple developers) envision the APIs to be used by experiment frameworks. Relevant classes and methods that come to mind:

  • Creation of (bare) RNTupleModel and RFieldTokens (for parallel writing, see also https://github.com/root-project/root/issues/16236)
  • Creation of (multiple) RNTupleWriter / RNTupleParallelWriter when Appending to a single TFile
  • For parallel writing, creation of RNTupleFillContext per thread or another granularity
  • Creation of (potentially multiple) REntrys and using BindRawPtr() to fill objects
  • Using FillNoCommit(), RNTupleFillStatus::ShouldCommitCluster(), a future FlushPageBuffers() (see https://github.com/root-project/root/issues/16241) and CommitCluster() to reduce the time in critical sections

hahnjo avatar Aug 22 '24 12:08 hahnjo