docs: add geometry requirements guide for optical photon simulation#305
Open
plexoos wants to merge 1 commit into
Open
docs: add geometry requirements guide for optical photon simulation#305plexoos wants to merge 1 commit into
plexoos wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a dedicated guide describing geometry authoring requirements and best practices for reliable optical photon simulation in this codebase, and links it from the top-level README to make it discoverable.
Changes:
- Add
docs/geometry-requirements.mdcovering naming, hierarchy/factorization constraints, selective triangulation guidance, and validation expectations. - Link the new guidance from
README.mdunder a “Geometry Guidance” section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/geometry-requirements.md | New guide documenting geometry constraints (analytic vs triangulated, instancing/factorization limits) and validation workflow for optical studies. |
| README.md | Adds a pointer to the new geometry guidance document for users authoring GDML/Geant4 geometry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
298791a to
c254938
Compare
ggalgoczi
requested changes
May 9, 2026
Contributor
ggalgoczi
left a comment
There was a problem hiding this comment.
- Two simphony references at lines 4 and 257, Copilot flagged on 2026-04-23, still unresolved. Should be eic-opticks/simg4ox until/unless PR #298 lands.
- Coordinate with the readthedocs branch, it already has docs/geometry.md and a Sphinx toctree. Either rename this PR's file (e.g. docs/geometry-authoring.md) so the layering is explicit, or replace the existing geometry.md. Either way, add it to docs/index.rst::toctree or it won't render on the docs site.
- Add the explicit "required optical properties" list (RINDEX / GROUPVEL / EFFICIENCY / REFLECTIVITY + the WLS triplet) — currently requirement #7 vaguely says "required optical properties" without naming them.
- Per-rule "how violations surface" notes, makes the doc actionable. E.g. rule #1 → silent mis-triangulation; rule #6 → photon leakage observable in GPUPhotonSource GPU/G4 comparison.
- 2–3 small GDML snippets (clean repeated-LV subtree, isolated triangulation candidate, clean optical-boundary stack). All-prose makes the rules harder to apply. 6. Verify U4Mesh__NumberOfRotationSteps_* is the current API name (line 169-170).
Contributor
|
My main concern with this PR is that it is misleading potential users. It claims triangulization is usable under current code. However AFAIK we never used it. Please either prove that it works or mention that is untested. |
81ea2fc to
f0188cc
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.