xtrack 0.86.2__tar.gz → 0.86.3__tar.gz

{xtrack-0.86.2/xtrack.egg-info → xtrack-0.86.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xtrack
-Version: 0.86.2
+Version: 0.86.3
 Summary: Tracking library for particle accelerators
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xtrack

{xtrack-0.86.2 → xtrack-0.86.3}/tests/test_radiation_equilibrium_emittances.py

@@ -124,32 +124,32 @@ def test_eq_emitt(conf):
     if not tilt_machine_by_90_degrees and not vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 7.09232e-10, atol=0,     rtol=1e-4)
         xo.assert_allclose(ey, 0,           atol=1e-14, rtol=0)
-        xo.assert_allclose(ez, 3.43821e-06, atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.36956e-06, atol=0,     rtol=1e-4)
         checked = True
     elif tilt_machine_by_90_degrees and not vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 0,           atol=1e-14, rtol=0)
         xo.assert_allclose(ey, 7.09232e-10, atol=0,     rtol=1e-4)
-        xo.assert_allclose(ez, 3.43821e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.36956e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif not tilt_machine_by_90_degrees and not vertical_orbit_distortion and wiggler_on:
         xo.assert_allclose(ex, 7.0283e-10, atol=0,     rtol=1e-4)
         xo.assert_allclose(ey, 5.5765e-13, atol=0,     rtol=4e-3)
-        xo.assert_allclose(ez, 3.6860e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.6042e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif tilt_machine_by_90_degrees and not vertical_orbit_distortion and wiggler_on:
         xo.assert_allclose(ex, 5.5790e-13, atol=0,     rtol=4e-3)  # Quite large, to be kept in mind
         xo.assert_allclose(ey, 7.0283e-10, atol=0,     rtol=1e-4)
-        xo.assert_allclose(ez, 3.6860e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.6042e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif not tilt_machine_by_90_degrees and vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 7.0911e-10, atol=0,     rtol=1e-4)
         xo.assert_allclose(ey, 2.1821e-12, atol=0,     rtol=1e-2)
-        xo.assert_allclose(ez, 3.4221e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.3536e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif tilt_machine_by_90_degrees and vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 2.1828e-12, atol=0,     rtol=7e-3)
         xo.assert_allclose(ey, 7.0911e-10, atol=0,     rtol=1e-4)
-        xo.assert_allclose(ez, 3.4221e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.3536e-6,  atol=0,     rtol=1e-4)
         checked = True
     else:
         raise ValueError('Unknown configuration')
@@ -159,11 +159,11 @@ def test_eq_emitt(conf):
     # Check radiation integrals
     tw_integ = line.twiss(radiation_integrals=True)
     xo.assert_allclose(tw_integ.rad_int_damping_constant_x_s,
-                       tw_rad.damping_constants_s[0], rtol=0.02, atol=0)
+                       tw_rad.damping_constants_s[0], rtol=0.025, atol=0)
     xo.assert_allclose(tw_integ.rad_int_damping_constant_y_s,
-                       tw_rad.damping_constants_s[1], rtol=0.02, atol=0)
+                       tw_rad.damping_constants_s[1], rtol=0.025, atol=0)
     xo.assert_allclose(tw_integ.rad_int_damping_constant_zeta_s,
-                       tw_rad.damping_constants_s[2], rtol=0.02, atol=0)
+                       tw_rad.damping_constants_s[2], rtol=0.025, atol=0)
     xo.assert_allclose(tw_integ.rad_int_eq_gemitt_x, ex, rtol=0.15, atol=1e-14)
     xo.assert_allclose(tw_integ.rad_int_eq_gemitt_y, ey, rtol=0.15, atol=1e-14)
 

{xtrack-0.86.2 → xtrack-0.86.3}/tests/test_radiation_equilibrium_emittances_thick.py

@@ -131,32 +131,32 @@ def test_eq_emitt(conf):
     if not tilt_machine_by_90_degrees and not vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 7.0923e-10, atol=0,     rtol=1e-4)
         xo.assert_allclose(ey, 0,          atol=1e-14, rtol=0)
-        xo.assert_allclose(ez, 3.5778e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.5064e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif tilt_machine_by_90_degrees and not vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 0,          atol=1e-14, rtol=0)
         xo.assert_allclose(ey, 7.0923e-10, atol=0,     rtol=1e-4)
-        xo.assert_allclose(ez, 3.5778e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.5064e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif not tilt_machine_by_90_degrees and not vertical_orbit_distortion and wiggler_on:
         xo.assert_allclose(ex, 7.0283e-10, atol=0,     rtol=1e-4)
         xo.assert_allclose(ey, 5.6461e-13, atol=0,     rtol=4e-3)
-        xo.assert_allclose(ez, 3.8357e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.7506e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif tilt_machine_by_90_degrees and not vertical_orbit_distortion and wiggler_on:
         xo.assert_allclose(ex, 5.6448e-13, atol=0,     rtol=1e-2)  # Quite large, to be kept in mind
         xo.assert_allclose(ey, 7.0283e-10, atol=0,     rtol=1e-4)
-        xo.assert_allclose(ez, 3.8357e-6,  atol=0,     rtol=1e-4)
+        xo.assert_allclose(ez, 3.7506e-6,  atol=0,     rtol=1e-4)
         checked = True
     elif not tilt_machine_by_90_degrees and vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 7.0910e-10, atol=0,     rtol=1e-4)
         xo.assert_allclose(ey, 2.2195e-12, atol=0,     rtol=7e-3)
-        xo.assert_allclose(ez, 3.5607e-6,  atol=0,     rtol=2e-4)
+        xo.assert_allclose(ez, 3.4899e-6,  atol=0,     rtol=2e-4)
         checked = True
     elif tilt_machine_by_90_degrees and vertical_orbit_distortion and not wiggler_on:
         xo.assert_allclose(ex, 2.2154e-12, atol=0,     rtol=7e-3)
         xo.assert_allclose(ey, 7.0911e-10, atol=0,     rtol=1e-4)
-        xo.assert_allclose(ez, 3.5607e-6,  atol=0,     rtol=2e-4)
+        xo.assert_allclose(ez, 3.4899e-6,  atol=0,     rtol=2e-4)
         checked = True
     else:
         raise ValueError('Unknown configuration')
@@ -166,11 +166,11 @@ def test_eq_emitt(conf):
     # Check radiation integrals
     tw_integ = line.twiss(radiation_integrals=True)
     xo.assert_allclose(tw_integ.rad_int_damping_constant_x_s,
-                       tw_rad.damping_constants_s[0], rtol=0.02, atol=0)
+                       tw_rad.damping_constants_s[0], rtol=0.025, atol=0)
     xo.assert_allclose(tw_integ.rad_int_damping_constant_y_s,
-                       tw_rad.damping_constants_s[1], rtol=0.02, atol=0)
+                       tw_rad.damping_constants_s[1], rtol=0.025, atol=0)
     xo.assert_allclose(tw_integ.rad_int_damping_constant_zeta_s,
-                       tw_rad.damping_constants_s[2], rtol=0.02, atol=0)
+                       tw_rad.damping_constants_s[2], rtol=0.025, atol=0)
     xo.assert_allclose(tw_integ.rad_int_eq_gemitt_x, ex, rtol=0.15, atol=1e-14)
     xo.assert_allclose(tw_integ.rad_int_eq_gemitt_y, ey, rtol=0.15, atol=1e-14)
 

{xtrack-0.86.2 → xtrack-0.86.3}/tests/test_tapering.py

@@ -37,7 +37,7 @@ def test_tapering_and_twiss_with_radiation():
     line.configure_radiation(model='mean')
     # - Set cavity lags to compensate energy loss
     # - Taper magnet strengths
-    line.compensate_radiation_energy_loss()
+    line.compensate_radiation_energy_loss(delta0=0)
 
     for conf in configs:
         print(f'Running test with conf: {conf}')
@@ -126,3 +126,64 @@ def test_tapering_and_twiss_with_radiation():
         xo.assert_allclose(
             line['rf3'].voltage*np.sin((line['rf'].lag + line['rf'].lag_taper)/180*np.pi),
             eneloss/4, rtol=3e-5)
+
+def test_tapering_zero_mean():
+
+    filename = test_data_folder / 'clic_dr/line_for_taper.json'
+    with open(filename, 'r') as f:
+        line = xt.Line.from_dict(json.load(f))
+
+    line.build_tracker()
+
+    line['rf3'].voltage = 0. # desymmetrize the rf
+    line['rf'].voltage = 0.  # desymmetrize the rf
+
+    line['rf1'].voltage *= 2
+    line['rf2b'].voltage *= 2
+    line['rf2a'].voltage *= 2
+
+    line.particle_ref.p0c = 4e9  # eV
+
+    line.configure_radiation(model=None)
+    tw_no_rad = line.twiss(method='4d', freeze_longitudinal=True)
+
+    ###############################################
+    # Enable radiation and compensate energy loss #
+    ###############################################
+
+    line.configure_radiation(model='mean')
+
+    # - Set cavity lags to compensate energy loss
+    # - Taper magnet strengths to avoid optics and orbit distortions
+    line.compensate_radiation_energy_loss(max_iter=100, delta0='zero_mean')
+
+    ##############################
+    # Twiss to check the results #
+    ##############################
+
+    tw = line.twiss(method='6d')
+
+    tw.delta # contains the momentum deviation along the ring
+
+    #!end-doc-part
+
+    p0corr = 1 + tw.delta
+
+    delta_ave = np.trapezoid(tw.delta, tw.s)/tw.s[-1]
+    xo.assert_allclose(delta_ave, 0, rtol=0, atol=1e-6)
+
+    xo.assert_allclose(tw.qx, tw_no_rad.qx, rtol=0, atol=5e-4)
+    xo.assert_allclose(tw.qy, tw_no_rad.qy, rtol=0, atol=5e-4)
+
+    xo.assert_allclose(tw.dqx, tw_no_rad.dqx, rtol=0, atol=1.5e-2*tw.qx)
+    xo.assert_allclose(tw.dqy, tw_no_rad.dqy, rtol=0, atol=1.5e-2*tw.qy)
+
+    xo.assert_allclose(tw.x, tw_no_rad.x, rtol=0, atol=1e-7)
+    xo.assert_allclose(tw.y, tw_no_rad.y, rtol=0, atol=1e-7)
+
+    xo.assert_allclose(tw.betx*p0corr, tw_no_rad.betx, rtol=2e-2, atol=0)
+    xo.assert_allclose(tw.bety*p0corr, tw_no_rad.bety, rtol=2e-2, atol=0)
+
+    xo.assert_allclose(tw.dx, tw.dx, rtol=0.0, atol=0.1e-3)
+
+    xo.assert_allclose(tw.dy, tw.dy, rtol=0.0, atol=0.1e-3)

xtrack-0.86.3/xtrack/_version.py

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

{xtrack-0.86.2 → xtrack-0.86.3}/xtrack/line.py

@@ -3232,7 +3232,7 @@ class Line:
             self, element=element, update_every=update_every, **kwargs
         )
 
-    def compensate_radiation_energy_loss(self, delta0=0, rtol_eneloss=1e-10,
+    def compensate_radiation_energy_loss(self, delta0='zero_mean', rtol_eneloss=1e-10,
                                     max_iter=100, **kwargs):
 
         """
@@ -3242,7 +3242,9 @@ class Line:
         Parameters
         ----------
         delta0: float
-            Initial energy deviation.
+            Initial energy deviation. If `delta0='zero_mean'` is specified, the
+            compensation is done such that the mean energy deviation along the
+            ring is zero.
         rtol_eneloss: float
             Relative tolerance on energy loss.
         max_iter: int

{xtrack-0.86.2 → xtrack-0.86.3}/xtrack/tapering.py

@@ -6,7 +6,7 @@ from .general import _print
 import xtrack as xt
 import xobjects as xo
 
-def compensate_radiation_energy_loss(line, delta0=0, rtol_eneloss=1e-12,
+def compensate_radiation_energy_loss(line, delta0='zeto_mean', rtol_eneloss=1e-12,
                                      max_iter=100, verbose=True,
                                      co_search_at=None,
                                      **kwargs):
@@ -37,7 +37,7 @@ def compensate_radiation_energy_loss(line, delta0=0, rtol_eneloss=1e-12,
 
     # Check whether compensation is needed
     p_test = particle_on_co.copy()
-    p_test.delta = delta0
+    p_test.delta = line.attr._cache['delta_taper'].multisetter.get_values()[0]
     line.track(p_test, turn_by_turn_monitor='ONE_TURN_EBE')
     mon = line.record_last_track
     eloss = -(mon.ptau[0, -1] - mon.ptau[0, 0]) * p_test.p0c[0]
@@ -67,28 +67,45 @@ def compensate_radiation_energy_loss(line, delta0=0, rtol_eneloss=1e-12,
         line.config.XTRACK_MULTIPOLE_TAPER = True
         line.config.XTRACK_DIPOLEEDGE_TAPER = True
 
-        i_iter = 0
-        while True:
-            p_test = particle_on_co.copy()
-            p_test.delta = delta0
-            line.track(p_test, turn_by_turn_monitor='ONE_TURN_EBE')
-            mon = line.record_last_track
+        if delta0 == 'zero_mean':
+            num_rounds = 2
+            delta_start = 0
+        else:
+            num_rounds = 1
+            delta_start = delta0
 
-            if record_iterations:
-                line._tapering_iterations.append(mon)
+        for round in range(num_rounds):
+            i_iter = 0
 
-            eloss = -(mon.ptau[0, -1] - mon.ptau[0, 0]) * p_test.p0c[0]
-            if verbose: _print(f"Energy loss: {eloss:.3f} eV             ")#, end='\r', flush=True)
+            while True:
 
-            if eloss < p_test.energy0[0] * rtol_eneloss:
-                break
+                if round == 1 and delta0 == 'zero_mean':
+                    delta_ave = xt.twiss.trapz(delta, ss) / ss[-1]
+                    delta_start -= delta_ave
 
-            v_setter.set_values(v_setter.get_values()
-                                + eloss * eneloss_partitioning)
+                p_test = particle_on_co.copy()
+                p_test.delta = delta_start
+                line.track(p_test, turn_by_turn_monitor='ONE_TURN_EBE')
+                mon = line.record_last_track
 
-            i_iter += 1
-            if i_iter > max_iter:
-                raise RuntimeError("Maximum number of iterations reached")
+                if record_iterations:
+                    line._tapering_iterations.append(mon)
+
+                eloss = -(mon.ptau[0, -1] - mon.ptau[0, 0]) * p_test.p0c[0]
+                if verbose: _print(f"Energy loss: {eloss:_.3f} eV             ")#, end='\r', flush=True)
+
+                if np.abs(eloss) < p_test.energy0[0] * rtol_eneloss:
+                    break
+
+                v_setter.set_values(v_setter.get_values()
+                                    + eloss * eneloss_partitioning)
+
+                delta = mon.delta[0, :-1]
+                ss = mon.s[0, :-1]
+
+                i_iter += 1
+                if i_iter > max_iter:
+                    raise RuntimeError("Maximum number of iterations reached")
     if verbose: _print()
     delta_taper_full = 0.5*(mon.delta[0, :-1] + mon.delta[0, 1:]) # last point is added by the monitor
 

{xtrack-0.86.2 → xtrack-0.86.3/xtrack.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xtrack
-Version: 0.86.2
+Version: 0.86.3
 Summary: Tracking library for particle accelerators
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xtrack

xtrack-0.86.2/xtrack/_version.py

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