xtrack 0.69.4__tar.gz → 0.69.6__tar.gz

{xtrack-0.69.4/xtrack.egg-info → xtrack-0.69.6}/PKG-INFO

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

xtrack-0.69.6/tests/test_rbend_rbarc.py

@@ -0,0 +1,72 @@
+import numpy as np
+import xtrack as xt
+import xobjects as xo
+from cpymad.madx import Madx
+
+def test_rbend_rbarc():
+    mad = Madx()
+    mad.input('''
+        ang = 0.6;
+        lb = 0.5;
+        rb: rbend, l=lb, angle=ang;
+
+        beam, particle=proton, energy=1.0;
+        seq: sequence, l=2;
+        rb, at=1;
+        endsequence;
+        use, sequence=seq;
+    ''')
+    tw = xt.Table(mad.twiss(betx=1.0, bety=1.0))
+
+    ds_madx = tw['s', 'rb:1'] - tw['s', 'rb:1<<1']
+
+    line = xt.Line.from_madx_sequence(mad.sequence.seq)
+
+    xo.assert_allclose(ds_madx, line['rb'].length, atol=0, rtol=1e-12)
+
+    env = xt.Environment()
+    env['lb'] = 0.5
+    env['ang'] = 0.6
+    env.new('rb_rbarc', xt.Bend)
+    env.set('rb_rbarc', length='lb', angle='ang', rbend=True, rbarc=True, k0_from_h=True)
+
+    xo.assert_allclose(env['rb_rbarc'].length, ds_madx, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['rb_rbarc'].h * env['rb_rbarc'].length, 0.6, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['rb_rbarc'].edge_entry_angle, 0.3, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['rb_rbarc'].edge_exit_angle, 0.3, atol=0, rtol=1e-12)
+
+    assert env['rb_rbarc'].get_expr('length') == "(vars['lb'] / f['sinc']((0.5 * vars['ang'])))"
+    assert env['rb_rbarc'].get_expr('h') == "(f['sin']((0.5 * vars['ang'])) / (0.5 * vars['lb']))"
+    assert env['rb_rbarc'].get_expr('k0') == env['rb_rbarc'].get_expr('h')
+    assert env['rb_rbarc'].get_expr('edge_entry_angle') == "(0.0 + (vars['ang'] / 2))"
+    assert env['rb_rbarc'].get_expr('edge_exit_angle') == "(0.0 + (vars['ang'] / 2))"
+
+    env.new('rb_norbarc', xt.Bend)
+    env.set('rb_norbarc', length='lb', angle='ang', rbend=True, rbarc=False, k0_from_h=True)
+
+    xo.assert_allclose(env['rb_norbarc'].length, 0.5, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['rb_norbarc'].h * env['rb_norbarc'].length, 0.6, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['rb_norbarc'].k0, env['rb_norbarc'].h, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['rb_norbarc'].edge_entry_angle, 0.3, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['rb_norbarc'].edge_exit_angle, 0.3, atol=0, rtol=1e-12)
+
+    assert env['rb_norbarc'].get_expr('length') == "vars['lb']"
+    assert env['rb_norbarc'].get_expr('h') == "(vars['ang'] / vars['lb'])"
+    assert env['rb_norbarc'].get_expr('k0') == env['rb_norbarc'].get_expr('h')
+    assert env['rb_norbarc'].get_expr('edge_entry_angle') == "(0.0 + (vars['ang'] / 2))"
+    assert env['rb_norbarc'].get_expr('edge_exit_angle') == "(0.0 + (vars['ang'] / 2))"
+
+    # Check an sbend
+    env.new('sb', xt.Bend)
+    env.set('sb', length='lb', angle='ang', rbend=False, rbarc=True, k0_from_h=True)
+
+    xo.assert_allclose(env['sb'].length, 0.5, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['sb'].h * env['sb'].length, 0.6, atol=0, rtol=1e-12)
+    xo.assert_allclose(env['sb'].edge_entry_angle, 0, atol=1e-12, rtol=0)
+    xo.assert_allclose(env['sb'].edge_exit_angle, 0, atol=1e-12, rtol=0)
+
+    assert env['sb'].get_expr('length') == "vars['lb']"
+    assert env['sb'].get_expr('h') == "(vars['ang'] / vars['lb'])"
+    assert env['sb'].get_expr('k0') == env['sb'].get_expr('h')
+    assert env['sb'].get_expr('edge_entry_angle') == None
+    assert env['sb'].get_expr('edge_exit_angle') == None

{xtrack-0.69.4 → xtrack-0.69.6}/tests/test_twiss.py

@@ -1930,3 +1930,47 @@ def test_twiss_add_strengths(test_context):
     assert "length" not in tw.keys()
     tw.add_strengths()
     assert "length" in tw.keys()
+
+def test_coupling_calculations():
+
+    # Load a line and build tracker
+    line = xt.Line.from_json(test_data_folder /
+        'hllhc14_no_errors_with_coupling_knobs/line_b1.json')
+    line.particle_ref = xt.Particles(mass0=xt.PROTON_MASS_EV, q0=1, energy0=7e12)
+    line.cycle('ip1', inplace=True)
+    line.twiss_default['method'] = '4d'
+
+    # Flat machine
+    for nn in line.vars.get_table().rows['on_.*|corr_.*'].name:
+        line.vars[nn] = 0
+
+    line['cmrskew'] = 0
+    line['cmiskew'] = 0
+    tw0 = line.twiss()
+
+    line['cmrskew'] = 0.5e-4
+    line['cmiskew'] = -0.3e-4
+
+    tw = line.twiss(strengths = True)
+
+    c_min_from_k1s = (0+0j) * tw.s
+    for ii in xt.progress_indicator.progress(range(len(tw.s))):
+        c_min_from_k1s[ii] = 1 / (2*np.pi) * np.sum(tw.k1sl * np.sqrt(tw0.betx * tw0.bety)
+                * np.exp(1j * 2 * np.pi * ((tw0.mux - tw0.mux[ii]) - (tw0.muy - tw0.muy[ii]))))
+
+    xo.assert_allclose(tw.c_minus_re + 1j*tw.c_minus_im, c_min_from_k1s, rtol=5e-2, atol=0)
+    # Check phi1
+    xo.assert_allclose(tw.c_minus_re + 1j*tw.c_minus_im,
+        tw.c_minus * np.exp(1j * tw.c_phi1), rtol=1e-10, atol=0)
+    # Check phi2
+    xo.assert_allclose(tw.c_minus_re + 1j*tw.c_minus_im,
+        tw.c_minus * np.exp(1j * (np.pi - tw.c_phi2)), rtol=3e-2, atol=0)
+    # Check r1
+    xo.assert_allclose(tw.c_r1, np.sqrt(tw.bety1 / tw.betx1), rtol=1e-5, atol=0)
+    # Check r2
+    xo.assert_allclose(tw.c_r2, np.sqrt(tw.betx2 / tw.bety2), rtol=1e-5, atol=0)
+
+    # Check c_minus
+    xo.assert_allclose(np.abs(tw.c_minus_re + 1j*tw.c_minus_im), tw.c_minus, rtol=1e-10, atol=0)
+    xo.assert_allclose(tw.c_minus_re_0, tw.c_minus_re[0], rtol=1e-10, atol=0)
+    xo.assert_allclose(tw.c_minus_im_0, tw.c_minus_im[0], rtol=1e-10, atol=0)

xtrack-0.69.6/xtrack/_version.py

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

{xtrack-0.69.4 → xtrack-0.69.6}/xtrack/environment.py

@@ -603,7 +603,7 @@ class EnvRef:
 def _handle_bend_kwargs(kwargs, _eval, env=None, name=None):
 
     kwargs = kwargs.copy()
-    rbarc = kwargs.pop('rbarc', False)
+    rbarc = kwargs.pop('rbarc', True)
     rbend = kwargs.pop('rbend', False)
 
     if rbarc:
@@ -644,7 +644,7 @@ def _handle_bend_kwargs(kwargs, _eval, env=None, name=None):
     else:
         angle = kwargs.get('h', 0) * length
 
-    if kwargs.pop('rbend', False):
+    if rbend:
         edge_entry_angle = kwargs.pop('edge_entry_angle', 0.)
         if isinstance(edge_entry_angle, str):
             edge_entry_angle = _eval(edge_entry_angle)

{xtrack-0.69.4 → xtrack-0.69.6}/xtrack/line.py

@@ -886,6 +886,28 @@ class Line:
             self.particle_ref.t_sim = (
                 self.get_length() / self.particle_ref._xobject.beta0[0] / clight)
 
+    @property
+    def scattering(self):
+        if not hasattr(self, '_scattering') or self._scattering is None:
+            try:
+                from xcoll.line_tools import XcollScatteringAPI
+                self._scattering = XcollScatteringAPI(line=self)
+            except ImportError as error:
+                raise ImportError("Please install Xcoll to use this feature.") from error
+
+        return self._scattering
+
+    @property
+    def collimators(self):
+        if not hasattr(self, '_collimators') or self._collimators is None:
+            try:
+                from xcoll.line_tools import XcollCollimatorAPI
+                self._collimators = XcollCollimatorAPI(line=self)
+            except ImportError as error:
+                raise ImportError("Please install Xcoll to use this feature.") from error
+
+        return self._collimators
+
     def discard_tracker(self):
 
         """
@@ -4402,6 +4424,9 @@ class Line:
 def frac(x):
     return x % 1
 
+def sinc(x):
+    return np.sinc(x / np.pi)
+
 class Functions:
 
     _mathfunctions = dict(
@@ -4419,7 +4444,7 @@ class Functions:
         sinh = math.sinh,
         cosh = math.cosh,
         tanh = math.tanh,
-        sinc = np.sinc,
+        sinc = sinc,
         abs = math.fabs,
         erf = math.erf,
         erfc = math.erfc,
@@ -4524,7 +4549,12 @@ def mk_class_namespace(extra_classes):
         all_classes = element_classes + xf.element_classes + extra_classes + (Line,)
     except ImportError:
         all_classes = element_classes + extra_classes
-        log.warning("Xfields not installed correctly")
+        log.warning("Xfields not installed")
+    try:
+        import xcoll as xc
+        all_classes += xc.element_classes
+    except ImportError:
+        log.warning("Xcoll not installed")
 
     all_classes = all_classes + (EnergyProgram, xt.Replica)
 

{xtrack-0.69.4 → xtrack-0.69.6}/xtrack/twiss.py

@@ -221,6 +221,12 @@ def twiss_line(line, particle_ref=None, method=None,
             - bety1: computed vertical beta function (Mais-Ripken) in meters
             - betx2: computed horizontal beta function (Mais-Ripken) in meters
             - bety2: computed vertical beta function (Mais-Ripken) in meters
+            - c_minus_re: real part of the closest tune approach coefficient
+            - c_minus_im: imaginary part of the closest tune approach coefficient
+            - c_r1: horizontal r1 coefficient for betatron coupling
+            - c_r2: vertical r2 coefficient for betatron coupling
+            - c_phi1: phase advance of the closest tune approach coefficient
+            - c_phi2: phase advance of the closest tune approach coefficient
         The table also contains the following global quantities:
             - qx: horizontal tune
             - qy: vertical tune
@@ -230,6 +236,8 @@ def twiss_line(line, particle_ref=None, method=None,
             - ddqx: horizontal second order chromaticity (d^2 qx / d delta^2)
             - ddqy: vertical second order chromaticity (d^2 qy / d delta^2)
             - c_minus: closest tune approach coefficient
+            - c_minus_re_0: real part of the closest tune approach coefficient (at start of the ring)
+            - c_minus_im_0: imaginary part of the closest tune approach coefficient (at start of the ring)
             - slip_factor: slip factor (-1 / f_ref * d f_ref / d delta) (positive above transition)
             - momentum_compaction_factor: momentum compaction factor (slip_factor + 1/gamma_0^2)
             - T_rev0: reference revolution period in seconds
@@ -1223,27 +1231,51 @@ def _compute_global_quantities(line, twiss_res):
         if 'mux' in twiss_res._data: # Lattice functions are available
             mux = twiss_res['mux']
             muy = twiss_res['muy']
+
             # Coupling
-            r1 = (np.sqrt(twiss_res['bety1'])/
-                np.sqrt(twiss_res['betx1']))
-            r2 = (np.sqrt(twiss_res['betx2'])/
-                np.sqrt(twiss_res['bety2']))
+            # from Y. Luo et al., "Possible phase loop for the global betatron decoupling",
+            #  C-A/AP/#174, https://www.agsrhichome.bnl.gov//AP/ap_notes/ap_note_174.pdf
+            w11 = W_matrix[:, 0, 0]
+            w13 = W_matrix[:, 0, 2]
+            w14 = W_matrix[:, 0, 3]
+            w31 = W_matrix[:, 2, 0]
+            w32 = W_matrix[:, 2, 1]
+            w33 = W_matrix[:, 2, 2]
+
+            c_r1 = np.sqrt(w31**2 + w32**2) / w11
+            c_r2 = np.sqrt(w13**2 + w14**2) / w33
+            c_phi1 = np.arctan2(w32, w31)
+            c_phi2 = np.arctan2(w14, w13)
 
             # Coupling (https://arxiv.org/pdf/2005.02753.pdf)
-            cmin_arr = (2 * np.sqrt(r1*r2) *
+            # R. Jones, Measuring Tune, Chromaticity and Coupling,
+            # Proceedings of the 2018 CERN–Accelerator–School
+            cmin_arr = (2 * np.sqrt(c_r1*c_r2) *
                         np.abs(np.mod(mux[-1], 1) - np.mod(muy[-1], 1))
-                        /(1 + r1 * r2))
+                        /(1 + c_r1 * c_r2))
             c_minus = trapz(cmin_arr, s_vect)/(circumference)
-            c_r1_avg = trapz(r1, s_vect)/(circumference)
-            c_r2_avg = trapz(r2, s_vect)/(circumference)
+
+            c_minus_cplx = c_minus * np.exp(1j * c_phi1)
+            c_minus_re = np.real(c_minus_cplx)
+            c_minus_im = np.imag(c_minus_cplx)
 
             qs = np.abs(twiss_res['muzeta'][-1])
 
+            # Scalars
             twiss_res._data.update({
                 'qx': mux[-1], 'qy': muy[-1], 'qs': qs,
-                'c_minus': c_minus, 'c_r1_avg': c_r1_avg, 'c_r2_avg': c_r2_avg
+                'c_minus': c_minus,
+                'c_minus_re_0': c_minus_re[0], 'c_minus_im_0': c_minus_im[0],
             })
 
+            # Coupling columns
+            twiss_res['c_minus_re'] = c_minus_re
+            twiss_res['c_minus_im'] = c_minus_im
+            twiss_res['c_r1'] = c_r1
+            twiss_res['c_r2'] = c_r2
+            twiss_res['c_phi1'] = c_phi1
+            twiss_res['c_phi2'] = c_phi2
+
 def _compute_chromatic_functions(line, init, delta_chrom, steps_r_matrix,
                     matrix_responsiveness_tol, matrix_stability_tol, symplectify,
                     method='6d', use_full_inverse=False,

{xtrack-0.69.4 → xtrack-0.69.6/xtrack.egg-info}/PKG-INFO

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

{xtrack-0.69.4 → xtrack-0.69.6}/xtrack.egg-info/SOURCES.txt

@@ -74,6 +74,7 @@ tests/test_random_gen.py
 tests/test_random_gen_exp.py
 tests/test_random_gen_gauss.py
 tests/test_random_gen_ruth.py
+tests/test_rbend_rbarc.py
 tests/test_rf_track.py
 tests/test_rotation_signs.py
 tests/test_second_order_taylor_map.py

xtrack-0.69.4/xtrack/_version.py

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