Skip to content

Commit 996e558

Browse files
authored
Add information RDT calculation documentation (#30)
1 parent 26cb91b commit 996e558

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

optics_functions/rdt.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ def calculate_rdts(df: TfsDataFrame, rdts: Sequence[str],
3030
""" Calculates the Resonance Driving Terms.
3131
3232
Eq. (A8) in [FranchiAnalyticFormulas2017]_ .
33+
One might notice that this code implementation has a factor :math:`2 \pi` in the exponential
34+
term of the numerator that is not found in Eq. (A8) of the reference. This is due to the fact
35+
that in [FranchiAnalyticFormulas2017]_, phase advances are in radians whereas the expected
36+
values for this code are output by ``MAD-X``, which makes them in units of :math:`2 \pi`.
3337
3438
Args:
3539
df (TfsDataFrame): Twiss Dataframe.

0 commit comments

Comments
 (0)