Skip to content

Commit 0a19884

Browse files
authored
update multipole docs typo (BLAST-ImpactX#1213)
1 parent 8eef6d7 commit 0a19884

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/source/usage/python.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -980,7 +980,7 @@ This module provides elements and methods for the accelerator lattice.
980980
number of integration steps per slice used for symplectic integration
981981

982982

983-
.. py:class:: impactx.elements.ExactMultipole(ds, K_normal, K_skew, unit=0, dx=0, dy=0, rotation=0, aperture_x=0, aperture_y=0, int_order=2, mapsteps=5, nslice=1, name=None)
983+
.. py:class:: impactx.elements.ExactMultipole(ds, k_normal, k_skew, unit=0, dx=0, dy=0, rotation=0, aperture_x=0, aperture_y=0, int_order=2, mapsteps=5, nslice=1, name=None)
984984
985985
A thick Multipole magnet using the exact relativistic Hamiltonian, including all kinematic nonlinearities.
986986
The user must provide arrays containing normal and skew multipole coefficients, which can be specified up to arbitrarily high order.
@@ -996,8 +996,8 @@ This module provides elements and methods for the accelerator lattice.
996996
and H_2 is the term containing the vector potential, which is a superposition of multipole contributions.
997997

998998
:param ds: Segment length in m.
999-
:param K_normal: Array of normal multipole coefficients (in meter^(-m) OR in T/meter^(m-1) for m=1,2,3,..)
1000-
:param K_skew: Array of skew multipole coefficients (in meter^(-m) OR in T/meter^(m-1) for m=1,2,3,...)
999+
:param k_normal: Array of normal multipole coefficients (in meter^(-m) OR in T/meter^(m-1) for m=1,2,3,..)
1000+
:param k_skew: Array of skew multipole coefficients (in meter^(-m) OR in T/meter^(m-1) for m=1,2,3,...)
10011001
:param unit: specification of units for multipole coefficients (by default, these are normalized by magnetic rigidity)
10021002
:param dx: horizontal translation error in m
10031003
:param dy: vertical translation error in m

0 commit comments

Comments
 (0)