Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
cemitch99 committed Nov 19, 2024
1 parent e61eebc commit 02cb323
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/usage/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,7 @@ Lattice Elements
* ``<element_name>.repeat_x`` (``float``, in meters) horizontal period for repeated aperture masking (inactive by default)
* ``<element_name>.repeat_y`` (``float``, in meters) vertical period for repeated aperture masking (inactive by default)
* ``<element_name>.shape`` (``string``) shape of the aperture boundary: ``rectangular`` (default) or ``elliptical``
* ``<element_name>.action`` (``string``) action of the aperture domain: ``transmit`` (default) or ``absorb``
* ``<element_name>.dx`` (``float``, in meters) horizontal translation error
* ``<element_name>.dy`` (``float``, in meters) vertical translation error
* ``<element_name>.rotation`` (``float``, in degrees) rotation error in the transverse plane
Expand Down
5 changes: 5 additions & 0 deletions docs/source/usage/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -953,6 +953,7 @@ This module provides elements for the accelerator lattice.
:param repeat_x: horizontal period for repeated aperture masking (inactive by default) (meter)
:param repeat_y: vertical period for repeated aperture masking (inactive by default) (meter)
:param shape: aperture boundary shape: ``"rectangular"`` (default) or ``"elliptical"``
:param action: aperture domain action: ``"transmit"`` (default) or ``"absorb"``
:param dx: horizontal translation error in m
:param dy: vertical translation error in m
:param rotation: rotation error in the transverse plane [degrees]
Expand All @@ -962,6 +963,10 @@ This module provides elements for the accelerator lattice.
aperture type (rectangular, elliptical)

.. py:property:: action
aperture type (transmit, absorb)

.. py:property:: xmax
maximum horizontal coordinate
Expand Down

0 comments on commit 02cb323

Please sign in to comment.