Skip to content

Shell notes, background, TODO split - #4

Open
kjvbrt wants to merge 1 commit into
HEP-FCC:mainfrom
kjvbrt:feature/gen-ee-review
Open

Shell notes, background, TODO split#4
kjvbrt wants to merge 1 commit into
HEP-FCC:mainfrom
kjvbrt:feature/gen-ee-review

Conversation

@kjvbrt

@kjvbrt kjvbrt commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Summary

  • `whizard --version` check kept alongside `which whizard` (verifies both the sourced stack path and the version)
  • Note that Key4hep only supports bash, with guidance for csh/tcsh users
  • Tag shell command blocks as bash for syntax highlighting
  • Simplify WHIZARD/Pythia8 manual references to plain links instead of quoted excerpts
  • Add background explanations for Key4hep (and its e+e- generator ecosystem), Gaudi/k4run, and EDM4hep at their first mention; fix a pre-existing wrong claim that FCCAnalyses runs through Gaudi/k4run (it uses its own `fccanalysis` command, connecting only via EDM4hep)
  • Move the Open TODOs section out of `README.md` into a separate `TODO.md` so it doesn't clutter the tutorial itself

Test plan

  • Re-run `whizard mumuH.sin` + `k4run pythia_mumuH.py` and confirm still clean
  • Read through `Gen/ee/README.md` end to end for flow/accuracy

- whizard --version check kept alongside `which whizard` (verifies both
  the sourced stack path and the version)
- Note that Key4hep only supports bash, with guidance for csh/tcsh users
- Tag shell command blocks as bash for syntax highlighting
- Simplify WHIZARD/Pythia8 manual references to plain links instead of
  quoted excerpts
- Add background explanations for Key4hep (and its e+e- generator
  ecosystem), Gaudi/k4run, and EDM4hep at their first mention; fix a
  pre-existing wrong claim that FCCAnalyses runs through Gaudi/k4run
  (it uses its own fccanalysis command, connecting only via EDM4hep)
- Move the Open TODOs section out of README.md into a separate TODO.md
  so it doesn't clutter the tutorial itself
@kjvbrt kjvbrt changed the title Address Gen/ee review comments: shell notes, background, TODO split Shell notes, background, TODO split Aug 24, 2026
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.

1 participant