Update docs and notebooks#354
Conversation
for more information, see https://pre-commit.ci
Pull Request Test Coverage Report for Build 18010004209Details
💛 - Coveralls |
for more information, see https://pre-commit.ci
|
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. |
|
Thanks Saad, I agree adding the part before and after would be nice. |
SaelMo
left a comment
There was a problem hiding this comment.
A few stylistic suggestions, but the PR is seaworthy. Approved.
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:
ElectronTimingandDelayedElectronsTimingplugins with newElectronPropagation,ElectronPropagationPerpWires,DelayedElectronsPropagation, andDelayedElectronsPropagationPerpWiresplugins to better reflect current simulation components.VolumesMergerand addedVolumeProperties,VolumeSelection, andDefaultSimulationplugins, clarifying the roles of each in handling detector volumes and simulation defaults.Example notebook improvements:
VolumePropertiesassigns physical properties and volume IDs,VolumeSelectionfilters interactions in regions of interest, andSelectionMerger(with possible extensions likeLowEnergySimulation) merges selected interactions, replacing the previousVolumesMergerlogic.volume_properties, ensuring the workflow matches the updated plugin structure.