xtrack 0.84.7__tar.gz → 0.84.8__tar.gz

{xtrack-0.84.7/xtrack.egg-info → xtrack-0.84.8}/PKG-INFO

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

{xtrack-0.84.7 → xtrack-0.84.8}/tests/test_trajectory_correcton.py

@@ -637,3 +637,52 @@ def test_orbit_correction_with_limits():
     # Basic method should use more correctors
     assert np.sum(np.abs(kicks_x_basic) > 1e-10) > n_micado
     assert np.sum(np.abs(kicks_y_basic) > 1e-10) > n_micado
+
+
+def test_orbit_correction_with_delta_zero():
+
+    line = xt.Line.from_json(test_data_folder
+                             / 'hllhc15_thick/lhc_thick_with_knobs.json')
+    tt = line.get_table()
+
+    # Define elements to be used as monitors for orbit correction
+    # (for LHC all element names starting by "bpm" and not ending by "_entry" or "_exit")
+    tt_monitors = tt.rows['bpm.*'].rows['.*(?<!_entry)$'].rows['.*(?<!_exit)$']
+    line.steering_monitors_x = tt_monitors.name
+    line.steering_monitors_y = tt_monitors.name
+
+    # Define elements to be used as correctors for orbit correction
+    # (for LHC all element namesstarting by "mcb.", containing "h." or "v.")
+    tt_h_correctors = tt.rows['mcb.*'].rows[r'.*h\..*']
+    line.steering_correctors_x = tt_h_correctors.name
+    tt_v_correctors = tt.rows['mcb.*'].rows[r'.*v\..*']
+    line.steering_correctors_y = tt_v_correctors.name
+
+    # Reference twiss (no misalignments)
+    tw_ref = line.twiss4d()
+
+    # Create orbit correction object without running the correction
+    orbit_correction = line.correct_trajectory(twiss_table=tw_ref, run=False,
+                                            n_singular_values=250)
+
+    delta0 = 1e-4
+
+    # Twiss before correction
+    tw_before = line.twiss4d(delta0=delta0)
+    assert tw_before.x.std() > 7e-5
+    assert tw_before.y.std() < 1e-10
+
+    # Correct
+    orbit_correction.correct(delta0=delta0)
+
+    # Twiss after correction
+    tw_after = line.twiss4d(delta0=delta0)
+    assert tw_after.x.std() < 2e-5
+    assert tw_after.y.std() < 1e-10
+
+    # Extract correction strength
+    kicks_x = orbit_correction.x_correction.get_kick_values()
+    kicks_y = orbit_correction.y_correction.get_kick_values()
+
+    assert np.abs(kicks_x).max() < 2.5e-6
+    assert np.abs(kicks_y).max() < 1e-15

xtrack-0.84.8/xtrack/_version.py

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

{xtrack-0.84.7 → xtrack-0.84.8}/xtrack/environment.py

@@ -263,10 +263,15 @@ class Environment:
 
         _eval = self._xdeps_eval.eval
 
-        assert isinstance(parent, str) or parent in _ALLOWED_ELEMENT_TYPES_IN_NEW, (
+        if not (isinstance(parent, str) or parent in _ALLOWED_ELEMENT_TYPES_IN_NEW):
+            raise ValueError(
             'Only '
             + _STR_ALLOWED_ELEMENT_TYPES_IN_NEW
-            + ' elements are allowed in `new` for now.')
+            + ' elements are allowed in `new` for now. In this case it is possible '
+            + 'to create a new element using the class and add it to the environment '
+            + ' using `env.elements`. For example:\n\n'
+            + '`env.elements["myname"] = MyClass(...)`\n'
+            )
 
         needs_instantiation = True
         parent_element = None

{xtrack-0.84.7 → xtrack-0.84.8}/xtrack/trajectory_correction.py

@@ -314,7 +314,7 @@ class OrbitCorrectionSinglePlane:
         else:
             self._position_after = None
 
-    def _compute_tw_orbit(self):
+    def _compute_tw_orbit(self, delta0=None):
         if self.mode == 'open':
             # Initialized with betx=1, bety=1 (use W_matrix to avoid compilation)
             twinit = xt.TwissInit(W_matrix=np.eye(6),
@@ -326,7 +326,7 @@ class OrbitCorrectionSinglePlane:
         else:
             twinit = None
         tw_orbit = self.line.twiss4d(only_orbit=True, start=self.start, end=self.end,
-                                     init=twinit, reverse=False)
+                                     init=twinit, reverse=False, delta0=delta0)
         return tw_orbit
 
     def _measure_position(self, tw_orbit=None):
@@ -542,7 +542,7 @@ class TrajectoryCorrection:
 
     def correct(self, planes=None, n_micado=None, n_singular_values=None,
                 rcond=None, n_iter='auto', verbose=True, stop_iter_factor=0.1,
-                tol_position_std=1e-10):
+                tol_position_std=1e-10, delta0=None):
 
         '''
         Correct the trajectory in the horizontal and/or vertical plane.
@@ -609,7 +609,7 @@ class TrajectoryCorrection:
         if self.y_correction is not None:
             a_correction = self.y_correction
 
-        tw_orbit = a_correction._compute_tw_orbit()
+        tw_orbit = a_correction._compute_tw_orbit(delta0=delta0)
 
         if self.x_correction is not None:
             relative_limits_x = self.x_correction.corrector_limits
@@ -633,7 +633,7 @@ class TrajectoryCorrection:
                             corrector_limits=relative_limits_y)
 
             tw_orbit_prev = tw_orbit
-            tw_orbit = a_correction._compute_tw_orbit()
+            tw_orbit = a_correction._compute_tw_orbit(delta0=delta0)
 
             if n_iter == 'auto' and self.x_correction is not None and 'x' in planes:
                 new_position = self.x_correction._measure_position(tw_orbit)

{xtrack-0.84.7 → xtrack-0.84.8/xtrack.egg-info}/PKG-INFO

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

xtrack-0.84.7/xtrack/_version.py

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