Update documentation#93
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #93 +/- ##
=======================================
Coverage 99.92% 99.92%
=======================================
Files 38 38
Lines 1305 1305
=======================================
Hits 1304 1304
Misses 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Updates documentation and example scripts to use smaller default grid sizes for faster execution/rendering, while clarifying a few theoretical descriptions (LG mode notation, Gaussian Schell-model normalization, and inner-product definition).
Changes:
- Reduce grid
shapeand adjust related physical parameters (focal length, tile length, filter radius, propagation distances) in README, quickstart, and the 4f example. - Clarify documentation math/notation: Laguerre–Gaussian mode superscript sign, normalized Gaussian intensity for the Gaussian Schell-model, and explicit
Field.innerconvention in the user guide.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Shrinks the 4f example parameters to a smaller grid and consistent physical scales. |
| examples/optimization/training_petal_beam.py | Clarifies LG mode notation in the narrative comment. |
| examples/optical_systems/4f_system.py | Uses smaller grid/physical parameters; updates plane count wording to match the 0…4f planes. |
| docs/source/user-guide/spatial_coherence.rst | Documents the normalized Gaussian intensity used by gaussian_schell_model. |
| docs/source/user-guide/propagation.rst | Refines the description of the critical-distance geometry term. |
| docs/source/user-guide/fields.rst | Aligns the inner-product equation/notation with the library’s Field.inner convention. |
| docs/source/quickstart/index.rst | Updates quickstart plots/examples to smaller grids and adjusted distances/parameters. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Update 4f examples with smaller shape, and other minor changes.