HSF / HSF/phoenix

Enhancement: Interested in contributing EDM4hepLoader

Open
#478 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
88
Forks
105
Avg merge
16h 15m
Merged PRs (30d)
34

Description

I don't have any TypeScript experience :-) but I'm interested in contributing an event loader for the EDM4hep data model used by the key4HEP project. The data model contains both simulated and reconstructed quantities which would be useful to implement, but an initial goal is these simulated quantities:

  • MCParticles (which could be loaded as 'truth' tracks)
  • SimTrackerHits
  • SimCalorimeterHits

My approach would be to use the ScriptLoader to use JSROOT to read edm4hep.root files.

The EDM4hep data model does not contain geometry information beyond position (and in some cases momentum). Connection to geometry is done through the cellID fields which connect to DD4hep geometry objects. This will not be possible to replicate here unless there is some way of connecting the cellID back to the geometry in Phoenix. That's out of scope here (and likely not necessary until we need to show entire calorimeter blocks instead of simple hit positions).

The files in the EDM4hep data model do not use prescribed names for the collections of event-level information. A SimTrackerHits collection can be stored under any name, which will need to be defined in the event loader configuration (MCParticles are typically stored under that name, though, so it presents a convenient target for initial implementation).

Cc'ing @vvolkl since of interest.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the existing ScriptLoader and its use of JSROOT for reading event data. Define how configurable collection names should be supplied, then scope initial support for MCParticles, SimTrackerHits, and SimCalorimeterHits; geometry and cellID connections are explicitly out of scope. Done means these collections can be loaded from EDM4hep ROOT files for display.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data-visualization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.