Skip to content

Gen/ee: the fixes after - #17

Open
kjvbrt wants to merge 3 commits into
HEP-FCC:mainfrom
kjvbrt:gen/ee/fixes-after
Open

Gen/ee: the fixes after#17
kjvbrt wants to merge 3 commits into
HEP-FCC:mainfrom
kjvbrt:gen/ee/fixes-after

Conversation

@kjvbrt

@kjvbrt kjvbrt commented Sep 1, 2026

Copy link
Copy Markdown
Contributor
  • Add a top-level "Getting started" section with the git clone command, and a note in Gen/ee/README.md that all commands assume starting from that stage's folder
  • Prefix WHIZARD with OMP_NUM_THREADS=1 by default, since it otherwise grabs every core on the machine, unfriendly on shared nodes
  • Fence the three Q&A
    Details blocks with '>' to match the rest of the doc's blockquote-style asides
  • Rename the scratch working directories from test_whizard/ to whizard_prod/mumuH and pythia_prod/<mumuH|WW|ZZ>, split by tool rather than sample - also fixes WW/ZZ being nested under "test_whizard" despite using no WHIZARD step; verified the full pipeline end-to-end against the new layout
  • Clarify that "background" here means a different physics process (WW, ZZ), not FullSim-style beam-induced background overlay, which this tutorial doesn't include at all
  • Drop the top-level README's claims that each section has introductory slides and that students present their solutions, since neither was actually done

…e dirs

Add a top-level "Getting started" section with the git clone command, and
a note in Gen/ee/README.md that all commands assume starting from that
stage's folder.

Prefix WHIZARD with OMP_NUM_THREADS=1 by default, since it otherwise
grabs every core on the machine, which is unfriendly on shared nodes; join
it with the existing cross-section note into one numbered Notes: block.

Fence the three Q&A <details> blocks with '>' to match the rest of the
doc's blockquote-style asides.

Rename the scratch working directories from test_whizard/<sample> to
whizard_prod/mumuH and pythia_prod/<mumuH|WW|ZZ>, split by tool rather
than sample - this also fixes WW/ZZ being nested under "test_whizard"
despite using no WHIZARD step at all. Verified the full pipeline
end-to-end against the new layout.
Note in Gen/ee/README.md and solutions/backgrounds.md that "background"
here means a different physics process (WW, ZZ), not the beam-induced
background FullSim students may expect - this tutorial has no BIB
overlay at all.

Also drop the top-level README's claims that each section has
introductory slides and that students present their solutions, since
neither was actually done.
@kjvbrt kjvbrt changed the title Gen/ee: getting-started polish, OMP_NUM_THREADS, dir rename, terminology fix Gen/ee: the fixes after Sep 1, 2026
Should be relative to the already-cloned repo root, not include the
repo directory name itself.
Comment thread Gen/ee/README.md
repository:

```bash
cd Gen/ee

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

consider stating with a git clone and cd into the cloned repo?

Comment thread Gen/ee/README.md
> machine, which isn't friendly (or efficient) on shared/multi-user
> nodes. `OMP_NUM_THREADS=1` restricts it to a single thread; drop it
> if you're on a machine you have exclusively to yourself and want the
> integration step to finish faster.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think i would not suggest unsetting OMP_NUM_THREADS unless one knows what they are doing. Only for heavyweight processes will increasing the number of threads help.

Comment thread Gen/ee/README.md
Two settings are deliberately left out rather than pinned explicitly,
relying on their WHIZARD defaults:

> Notes:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

with "Notes:" here, the text is quite awkward. Perhaps the two sets of notes can just be merged?

Comment thread Gen/ee/README.md
@@ -175,13 +188,13 @@
> 1. To get a list of all available commandline arguments which one can use to

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

fwiw, the information flow in this section does not seem to follow a logical order as it starts with steering files, goes back to pythia files and eventually comes back to an actual steering file

(but thats not an issue with this PR).

don't need WHIZARD: Pythia8 can generate the hard process itself directly,
so this is a single Pythia8 step with no LHE file involved at all.

> **Note:** "Background" here means a different *physics process* (WW,

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

this text is also in the readme. Is that sufficient?

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.

2 participants