Add missing docs for Geant4 #120
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kmichalikk
temporarily deployed
to
github-pages
GitHub Actions
Inactive
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for the Geant4 simulator to address issue #2014. The changes transform previously placeholder "Under development" sections into detailed, step-by-step instructions with supporting screenshots.
Key Changes:
- Complete Geant4-specific beam and physics settings documentation
- Detailed detector setup and scoring configuration examples
- Documentation for Geant4 dataset management and simulation execution
- Comprehensive geometry creation guide with nested volume examples
Reviewed changes
Copilot reviewed 4 out of 24 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/settings.md | Adds beam configuration details and marks physics settings as unsupported |
| docs/scoring.md | Provides complete detector setup, scoring quantities, and particle filter examples |
| docs/running.md | Documents dataset download options and input file modification workflow |
| docs/geometry.md | Adds extensive geometry creation guide with volume hierarchy instructions |
| docs/assets/settings/geant4_beam_adjustments.png | Screenshot showing beam parameter configuration |
| docs/assets/scoring/geant4_*.png | Screenshots for detector setup, quantities, and filters |
| docs/assets/running/*.png | Screenshots for dataset management interface |
| docs/assets/geometry/*.png | Screenshots for geometry hierarchy and naming operations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
grzanka
approved these changes
Dec 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes yaptide/ui#2014