Repository navigation
docs: list of the algorithms, shapers, and link to slmsuite - #62
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…e page Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…efault shaper instead of configuration Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…configuration Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…ze and TorchOptim rows were out of the table) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…labels, icons, duplicate substitution) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…nd phase Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…hm pages (the manual references were inconsistent with the code) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…(as in PyMoDAQ docs) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…references Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
… to the Shaper actuator Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…references Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
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.
Summary
Documentation only. Stacked on #61 (base = its branch; retarget to
5.3.xonce it is merged).user_guide/algorithms.rst: the overview is now one table with every algorithm under the name shown in the interface (Direct, Diffractive, OL2014 checkerboard, Gerchberg-Saxton, Projections, slmsuite Hologram, Minimize, TorchOptim), its family, setup, iterative, amplitude/phase, references and remarks. It replaces the old "8 algorithms / 3 families" table (which listed Weighted GS and MRAF as separate algorithms, they are options of Projections, and described Minimize as Scipy-based while it uses pytorch-minimize).user_guide/shapers.rst: how the extension gets the shaper from theShaperactuator (shaper_geometry/shaper_propertiesgroups ofpymodaq_plugins_utils, config fallback, internal calibration choice) and the list of usable actuators (MockShaper, Holoeye, slmsuite).user_guide/slmsuite.rst, same level: what slmsuite is (license, links, citation advice), install with[beamshaping], the Shaper actuators, theslmsuite Hologramalgorithm and its methods.Tests
Sphinx build of the user guide pages: no warning from the new or changed content (existing warnings in other pages unchanged). Full docs build with the project theme/extensions not run.
🤖 Generated with Claude Code
https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS