docs: update docs/physics-and-inputs.md with GPU supported surface models#400
Open
plexoos wants to merge 2 commits into
Open
docs: update docs/physics-and-inputs.md with GPU supported surface models#400plexoos wants to merge 2 commits into
plexoos wants to merge 2 commits into
Conversation
Split the combined physics-and-inputs guide into separate physics and simulation input documents. Move the Geant4 optical-surface context and Simphony GPU surface support notes into docs/physics.md, including the standard surface payload behavior and unsupported Geant4 model features. Move torch configuration, application input modes, GDML scintillation requirements, primary-particle setup, and geometry-loading guidance into docs/inputs.md. Update the top-level and docs README indexes to link to the new pages.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the documentation by splitting the former combined “Physics and simulation inputs” content into two focused guides, and updates navigation links accordingly. This makes it clearer which information is physics-model behavior versus runtime/application configuration.
Changes:
- Add a new
docs/physics.mdguide describing the GPU optical-surface behavior and what GDML surface features are/aren’t supported on the standard GPU path. - Refocus
docs/inputs.mdto cover runtime configuration and application input modes, with cross-links to the new physics guide. - Update top-level and docs-level README navigation links to point to the new guide locations.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates documentation links to the new docs/physics.md and docs/inputs.md pages. |
| docs/README.md | Updates guides index to match the new split documentation structure. |
| docs/physics.md | New physics-focused guide documenting Geant4 surface models and Simphony GPU support/limitations. |
| docs/inputs.md | Removes physics content and updates sections/headings to focus on runtime/app input configuration with links to physics.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.