xtrack 0.98.11__tar.gz → 0.98.12__tar.gz

{xtrack-0.98.11/xtrack.egg-info → xtrack-0.98.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xtrack
-Version: 0.98.11
+Version: 0.98.12
 Summary: Tracking library for particle accelerators
 Author: G. Iadarola et al.
 License-Expression: Apache-2.0

{xtrack-0.98.11 → xtrack-0.98.12}/tests/test_bucket_with_ref_energy_change.py

@@ -4,6 +4,10 @@ import xobjects as xo
 
 import numpy as np
 from scipy.constants import c as clight
+import pathlib
+
+test_data_folder = pathlib.Path(
+    __file__).parent.joinpath('../test_data').absolute()
 
 def test_bucket_below_transition():
 
@@ -1014,3 +1018,30 @@ def test_bucket_with_reference_ernergy_increase_elem():
     xo.assert_allclose(z_std, np.mean(z_std), atol=0.025*sigma_z)
     xo.assert_allclose(delta_mean, np.mean(delta_mean), atol=0.025*sigma_delta)
     xo.assert_allclose(delta_std, np.mean(delta_std), atol=0.025*sigma_delta)
+
+def test_bucket_with_radiation():
+
+    env = xt.load(test_data_folder / 'fcc_ee/fccee_h.seq')
+    pc_gev = 120.
+
+    line = env.fccee_p_ring
+    line.set_particle_ref('positron', p0c=pc_gev*1e9)
+
+    tw_no_rad = line.twiss6d()
+    rfb_no_rad = line._get_bucket()
+
+    line.configure_radiation(model='mean')
+    line.compensate_radiation_energy_loss()
+
+    tw_rad = line.twiss6d(eneloss_and_damping=True)
+    rfb_rad = line._get_bucket()
+
+    # Check that the effect of the radiation is visible on qs
+    assert tw_no_rad.qs > 0.045
+    assert tw_rad.qs < 0.035
+
+    # Check consistency of qs and bets0 between twiss and rfb
+    xo.assert_allclose(rfb_no_rad.Q_s, tw_no_rad.qs, rtol=0.01)
+    xo.assert_allclose(rfb_rad.Q_s, tw_rad.qs, rtol=0.01)
+    xo.assert_allclose(rfb_no_rad.beta_z, tw_no_rad.bets0, rtol=0.015)
+    xo.assert_allclose(rfb_rad.beta_z, tw_rad.bets0, rtol=0.015)

xtrack-0.98.12/xtrack/_version.py

@@ -0,0 +1 @@
+__version__ = '0.98.12'

{xtrack-0.98.11 → xtrack-0.98.12}/xtrack/line.py

@@ -1748,29 +1748,95 @@ class Line:
                element0=0, reverse=None):
 
         """
-        Returns a survey of the beamline (based on MAD-X survey command).
+        Compute the geometrical layout, i.e. the coordinates of all beam line
+        elements in the global reference system. (for detailed definitions of
+        the involved quantities please refer to the Xsuite Physics Guide
+        (https://xsuite.readthedocs.io/en/latest/physicsguide.html)
 
         Parameters
         ----------
         X0 : float
-            Initial X coordinate in meters.
+            Initial X coordinate in meters. Default is 0.
         Y0 : float
-            Initial Y coordinate in meters.
+            Initial Y coordinate in meters. Default is 0.
         Z0 : float
-            Initial Z coordinate in meters.
+            Initial Z coordinate in meters. Default is 0.
         theta0 : float
-            Initial theta coordinate in radians.
+            Initial theta coordinate in radians. Default is 0.
         phi0 : float
-            Initial phi coordinate in radians.
+            Initial phi coordinate in radians. Default is 0.
         psi0 : float
-            Initial psi coordinate in radians.
+            Initial psi coordinate in radians. Default is 0.
         element0 : int or str
-            Element at which the given coordinates are defined.
+            Element at which the given coordinates are defined. Default is the
+            first element in the beam line.
+        reverse : bool
+            If True, the survey is computed in the reversed reference frame.
 
         Returns
         -------
         survey : SurveyTable
             Survey table.
+
+        Notes
+        -----
+
+        The output survey table contains the following columns:
+
+        - ``name``: element name (with occurrence counts for repeated names).
+        - ``element_type``: type of the element (e.g. Drift, Marker, Bend).
+        - ``s``: longitudinal coordinate at the element entrance [m].
+        - ``X``, ``Y``, ``Z``: position of the element entrance in the global frame [m].
+        - ``theta``, ``phi``, ``psi``: orientation angles of the local frame
+          (azimuth, elevation, roll) unwrapped along the line [rad].
+        - ``ex``, ``ey``, ``ez``: unit vectors of the local frame expressed in
+          the global frame (they are the columns of ``W``).
+        - ``W``: 3x3 rotation matrices describing the local frame at each
+          element entrance.
+        - ``p0``: position vectors stacked as ``[X, Y, Z]``.
+        - ``isthick``: ``True`` for thick elements, ``False`` for markers.
+        - ``drift_length``: length used while advancing the survey (zero for
+          thin elements) [m].
+        - ``length``: physical length of the element [m].
+        - ``angle``: bending angle of the element [rad].
+        - ``rot_s_rad``: rotation around the longitudinal axis applied before
+          the element [rad].
+        - ``ref_shift_x``, ``ref_shift_y``: alignment shifts applied before the
+          element [m].
+        - ``ref_rot_x_rad``, ``ref_rot_y_rad``, ``ref_rot_s_rad``: alignment
+          rotations applied before the element [rad].
+
+        Examples
+        --------
+        .. code-block:: python
+
+            import xtrack as xt
+
+            # Create a simple line
+            env = xt.Environment(particle_ref=xt.Particles(p0c=1e9))
+            line = env.new_line(length=6, components=[
+                env.new('b1', xt.Bend, length=0.2, angle=0.1, at=1),
+                env.new('q1', xt.Quadrupole, length=0.1, k1=0.5, at=2),
+                env.new('b2', xt.Bend, length=0.2, angle=-0.1, at=3),
+                env.new('q2', xt.Quadrupole, length=0.1, k1=-0.5, at=4),
+            ])
+
+            # Compute the survey
+            sv = line.survey()
+            # sv.X, sv.Y, sv.Z contain the coordinates of the reference
+            # trajectory in the global frame
+
+            # Compute the trajectory of a particle entering with x=1 mm and y=2 mm
+            tw = line.twiss4d(betx=1, bety=1, x=1e-3, y=2e-3)
+            # tw.x, tw.y contain the coordinates of the particle in the local frame
+
+            # Compute the trajectory of the particle in the global frame
+            p_global = tw.x[:, None] * sv.ex + tw.y[:, None] * sv.ey + sv.p0
+
+            X_trajectory = p_global[:, 0]
+            Y_trajectory = p_global[:, 1]
+            Z_trajectory = p_global[:, 2]
+
         """
 
         if not self._has_valid_tracker():

{xtrack-0.98.11 → xtrack-0.98.12/xtrack.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xtrack
-Version: 0.98.11
+Version: 0.98.12
 Summary: Tracking library for particle accelerators
 Author: G. Iadarola et al.
 License-Expression: Apache-2.0

xtrack-0.98.11/xtrack/_version.py

@@ -1 +0,0 @@
-__version__ = '0.98.11'