Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace the Legacy DataSvc and use the new Frame based one #120

Merged
merged 9 commits into from
Jul 21, 2023

Conversation

tmadlener
Copy link
Contributor

@tmadlener tmadlener commented Jul 6, 2023

BEGINRELEASENOTES

  • Switch the converters to use the new Frame based DataSvc components introduced in key4hep/k4FWCore#100
  • Use the MetaDataHandle for the CellIDEncoding string passing in the converters
  • Update the test inputs and expected outputs in order to be able to work with these changes
  • Update the documentation to also include the "workaround" for key4hep/k4FWCore#125

ENDRELEASENOTES

Needs

Includes changes from

TODO

  • Release Notes (waiting to see how this goes once all the bits and pieces are in place)
  • Remove k4LCIOReader dependency
  • Update tests (provide new input file)

@tmadlener
Copy link
Contributor Author

I opened key4hep/k4FWCore#125 to keep track of the non-zero (4) exit code of k4run and switched to simply ignoring the return value in the edm4hep converter test for now. It shouldn't really matter since there are checks afterwards that will catch problems, just debugging the test will become a bit more cumbersome.

@tmadlener tmadlener linked an issue Jul 20, 2023 that may be closed by this pull request
3 tasks
```bash
glced &

k4run $K4MARLINWRAPPER/examples/event_display.py --EventDataSvc.input=gamma_10GeV_edm4hep.root
k4run $K4MARLINWRAPPER/examples/event_display.py --EventDataSvc.input=gamma_10GeV_edm4hep.root || true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer this to be opt-in: we give the command without || true and then an explanation on why you may want to use it if running in a test or something like that, but that's kind of expert knowledge that is unlikely to be useful for most people

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that these bits of the documentation are run in the doctest workflow and without any handling of the non-zero exit code from k4run they will fail.

Comment on lines +138 to +139
result=$?
[ $result = "0" ] || [ $result = "4" ] && true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above, not needed for most people so it can be separated from the code that is going to be copied and pasted most of the time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Open issues for making wrapper work with non-legacy DataSvc
2 participants