Skip to content

Update docs and notebooks#354

Merged
cfuselli merged 5 commits into
mainfrom
update-docs-and-notebooks
Sep 25, 2025
Merged

Update docs and notebooks#354
cfuselli merged 5 commits into
mainfrom
update-docs-and-notebooks

Conversation

@cfuselli

Copy link
Copy Markdown
Member

This pull request updates documentation and example notebooks to reflect changes in the microphysics and detector physics plugin structure. The main focus is on clarifying and reorganizing how detector volume properties and selection are handled, and updating plugin names to match the current codebase.

Documentation updates for plugin structure:

  • Detector physics plugin list revised: Replaced the ElectronTiming and DelayedElectronsTiming plugins with new ElectronPropagation, ElectronPropagationPerpWires, DelayedElectronsPropagation, and DelayedElectronsPropagationPerpWires plugins to better reflect current simulation components.
  • Microphysics simulation plugin list updated: Removed VolumesMerger and added VolumeProperties, VolumeSelection, and DefaultSimulation plugins, clarifying the roles of each in handling detector volumes and simulation defaults.

Example notebook improvements:

  • Updated workflow description: The notebook now explains that VolumeProperties assigns physical properties and volume IDs, VolumeSelection filters interactions in regions of interest, and SelectionMerger (with possible extensions like LowEnergySimulation) merges selected interactions, replacing the previous VolumesMerger logic.
  • Added explicit step for volume properties: The example code now includes a call to generate volume_properties, ensuring the workflow matches the updated plugin structure.

@cfuselli cfuselli requested a review from HenningSE September 25, 2025 10:24
@coveralls

coveralls commented Sep 25, 2025

Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 18010004209

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 72.568%

Totals Coverage Status
Change from base Build 18003391922: 0.0%
Covered Lines: 2656
Relevant Lines: 3660

💛 - Coveralls

@cfuselli cfuselli requested a review from SaelMo September 25, 2025 13:22
@SaelMo

SaelMo commented Sep 25, 2025

Copy link
Copy Markdown
Contributor

You are describing the volume ID in the first notebook, an alright description, but wouldn’t it help to produce some code alongside it to make clear what you are doing? Also, a little silly (especially since it was already the case), but could you add two boxes to your image of the fuse pipeline: one just before it labeled “GEANT4/CSV data” and one after it labeled “straxen”?

The reason I think this would be helpful is that it makes clear where fuse plays a role in the broader simulation framework. It also helps since you’re connecting your boxes in the reverse order of the straxen documentation, which some analysts might be more familiar with.

@cfuselli

Copy link
Copy Markdown
Member Author

Thanks Saad, I agree adding the part before and after would be nice.
Because I am not a good designer I would leave this task to the future and see how we can improve it but still being good looking :)

@SaelMo SaelMo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few stylistic suggestions, but the PR is seaworthy. Approved.

@cfuselli cfuselli merged commit 3d960a2 into main Sep 25, 2025
6 checks passed
@cfuselli cfuselli deleted the update-docs-and-notebooks branch September 25, 2025 14:29
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.

3 participants