Skip to content

Commit

Permalink
Update python.rst
Browse files Browse the repository at this point in the history
Add math in k parameter description.
  • Loading branch information
cemitch99 authored May 6, 2024
1 parent 5b91c0e commit a4c88c3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/source/usage/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -927,11 +927,11 @@ This module provides elements for the accelerator lattice.
where :math:`g` is the (linear) field gradient in T/m and :math:`D_x` is the targeted horizontal dispersion in m.

:param k: integrated focusing strength in m^(-1) (if units = 0)
= (length in m) * (azimuthal magnetic field gradient in T/m) / (rigidity in T-m)
= (length in m) * (magnetic field gradient :math:`g` in T/m) / (rigidity in T-m)
OR integrated focusing strength in T (if units = 1)
= (length in m) * (azimuthal magnetic field gradient in T/m)
= (length in m) * (magnetic field gradient :math:`g` in T/m)
:param taper: horizontal taper parameter in m^(-1)
= 1 / (target horizontal dispersion in m)
= 1 / (target horizontal dispersion :math:`D_x` in m)
:param units: specification of units for plasma lens focusing strength
:param dx: horizontal translation error in m
:param dy: vertical translation error in m
Expand Down

0 comments on commit a4c88c3

Please sign in to comment.