Skip to content

README: use of the various BeamShaping algorithms - #6

Merged
seb5g merged 2 commits into
5.3.xfrom
docs/readme-algorithms
Oct 30, 2026
Merged

seb5g merged 2 commits into
5.3.xfrom
docs/readme-algorithms

Conversation

@seb5g

@seb5g seb5g commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

Summary

README only. The "BeamShaping algorithm" section becomes "BeamShaping algorithms":

  • how the extension discovers the algorithms (its own ones plus the pymodaq_plugins_beam_shaping.algorithms entry point), and how to install ([beamshaping] extra), name the actuator Shaper and choose the algorithm;
  • where the extension gets the SLM geometry and calibration (the Shaper actuator, pymodaq_plugins_utils contract);
  • the slmsuite Hologram algorithm: table of the methods (GS, WGS-*) with references, specific settings and slmsuite defaults, restart rules, GPU, conjugate gradient not exposed;
  • how to add an algorithm from another package.

Tests

README renders without docutils warnings. No code change.


Generated by Claude Code

…ctuators and the slmsuite Hologram algorithm

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
…evices

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CAhZwmbyCSpSgfTyicUxuS
@seb5g
seb5g marked this pull request as ready for review October 30, 2026 10:24
@seb5g
seb5g merged commit 44169ff into 5.3.x Oct 30, 2026
8 checks passed
@seb5g
seb5g deleted the docs/readme-algorithms branch October 30, 2026 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants