xcoll 0.6.3__py3-none-any.whl → 0.6.5__py3-none-any.whl

xcoll/beam_elements/elements_src/rf_sweep.h

@@ -0,0 +1,23 @@
+// copyright ############################### #
+// This file is part of the Xcoll package.   #
+// Copyright (c) CERN, 2025.                 #
+// ######################################### #
+
+#ifndef XCOLL_RF_SWEEP_H
+#define XCOLL_RF_SWEEP_H
+
+/*gpufun*/
+void RFSweep_track_local_particle(RFSweepData el, LocalParticle* part0){
+    double  const step = RFSweepData_get__rf_sweep_df_step(el); // L*df/(f0 + df)
+    int64_t const start_turn = RFSweepData_get_start_turn(el);
+    int64_t const stop_turn = RFSweepData_get_stop_turn(el);
+
+    //start_per_particle_block (part0->part)
+        int64_t at_turn = LocalParticle_get_at_turn(part);
+        if (at_turn >= start_turn && at_turn <= stop_turn){
+            LocalParticle_add_to_zeta(part, -(at_turn - start_turn + 1)*step);
+        }
+    //end_per_particle_block
+}
+
+#endif /* XCOLL_RF_SWEEP_H */

xcoll/general.py

@@ -12,5 +12,5 @@ citation = "F.F. Van der Veken, et al.: Recent Developments with the New Tools f
 # ======================
 # Do not change
 # ======================
-__version__ = '0.6.3'
+__version__ = '0.6.5'
 # ======================

xcoll/general.py.orig

@@ -0,0 +1,21 @@
+# copyright ############################### #
+# This file is part of the Xcoll package.   #
+# Copyright (c) CERN, 2025.                 #
+# ######################################### #
+
+from pathlib import Path
+
+_pkg_root = Path(__file__).parent.absolute()
+
+citation  = "F.F. Van der Veken, et al.: Recent Developments with the New Tools for Collimation "
+citation += "Simulations in Xsuite, Proceedings of HB2023, Geneva, Switzerland."
+
+# ======================
+# Do not change
+# ======================
+<<<<<<< HEAD
+__version__ = '0.7.0rc0'
+=======
+__version__ = '0.6.4'
+>>>>>>> main
+# ======================

xcoll/geometry.md

@@ -0,0 +1,42 @@
+PSEUDOCODE for material interactions tracking in collimator
+===========================================================
+
+- create DriftTrajectory from particle
+- loop:
+    - find first crossing with collimator shape (segments)
+    - if distance larger than end of BeamElement -> move particle to exendit and break loop
+    - move particle to collimator impact point
+    - create MCSTrajectory from new particle
+    - loop:
+        - find first crossing with collimator shape (segments)
+        - do not move, but calculate path length
+        - compare to distance to nuclear interaction
+        - shortest wins (nuclear or exit)
+        - move to next point
+    - when at exit, create DriftTrajectory from particle
+
+
+
+PSEUDOCODE for material interactions tracking in crystal
+========================================================
+
+- create DriftTrajectory from particle
+- loop:
+    - find first crossing with crystal shape (segments)
+    - if distance larger than end of BeamElement -> move particle to end and break loop
+    - move particle to crystal impact point
+    - create MCSTrajectory (if amorphous) or CircularTrajectory (if channelling) from new particle
+    - loop:
+        - find first crossing with crystal shape (segments)
+        - do not move, but calculate path length
+        - compare to distance to nuclear interaction and dechannelling
+        - shortest wins (nuclear, dechannelling, or exit)
+        - move to next point
+    - when at exit, create DriftTrajectory from particle
+
+
+PSEUDOCODE for crossing finder
+==============================
+
+- if DriftTrajectory and any segment
+=> use analytical

xcoll/{prebuild_kernels → prebuilt_kernel_definitions}/__init__.py

@@ -3,5 +3,5 @@
 # Copyright (c) CERN, 2025.                 #
 # ######################################### #
 
-from .elements import DEFAULT_XCOLL_ELEMENTS
+from .element_types import DEFAULT_XCOLL_ELEMENTS
 from .element_inits import XCOLL_ELEMENTS_INIT_DEFAULTS

xcoll/rf_sweep.py

@@ -4,12 +4,13 @@
 # ######################################### #
 
 import numpy as np
+from warnings import warn
 import scipy.constants as sc
 
 import xtrack as xt
 
 
-def prepare_rf_sweep(line, cavities=None, sweep=None, sweep_per_turn=None, num_turns=None):
+def prepare_rf_sweep(line, *, cavities=None, sweep=None, sweep_per_turn=None, num_turns=None):
     rf_sweep = RFSweep(line=line, cavities=cavities)
     rf_sweep.prepare(sweep=sweep, sweep_per_turn=sweep_per_turn, num_turns=num_turns)
 
@@ -17,57 +18,63 @@ def prepare_rf_sweep(line, cavities=None, sweep=None, sweep_per_turn=None, num_t
 class RFSweep:
     def __init__(self, line, cavities=None):
         self.line = line
-        if line._var_management is None:
-            raise ValueError("Line must have a `var_management` to use RFSweep!" \
+        if line.env.ref_manager is None:
+            raise ValueError("Environment must have a `ref_manager` to use RFSweep!" \
                            + "Do not use `optimize_for_tracking` as it will "
                            + "disable expressions, which are needed for RFSweep.")
+        line.enable_time_dependent_vars = False  # To be able to twiss in the prepare step
         self.env = line.env
         self.cavities = cavities
         self.env['rf_sweep_df'] = 0
+        self._prepared = False
 
     @property
     def current_sweep_value(self):
         return self.env['rf_sweep_df']
 
-    def prepare(self, sweep=None, sweep_per_turn=None, num_turns=None):
-        if sweep_per_turn is not None:
-            if np.isclose(sweep_per_turn, 0):
-                raise ValueError("Variable `sweep_per_turn` must be non-zero!")
-            if sweep is not None:
-                raise ValueError("Provide either `sweep` or `sweep_per_turn`, not both.")
-            if num_turns is not None:
-                raise ValueError("Variable `num_turns` cannot be set when using `sweep_per_turn`.")
-            self.sweep_per_turn = sweep_per_turn
-        elif sweep is not None:
-            if np.isclose(sweep, 0):
-                raise ValueError("Variable `sweep` must be non-zero!")
-            if num_turns is None:
-                num_turns = int(abs(sweep))
-            if num_turns <= 0:
-                raise ValueError("When using `sweep`, `num_turns` must be a positive integer.")
-            self.sweep_per_turn = sweep / num_turns
-        else:
-            raise ValueError("Either `sweep` or `sweep_per_turn` must be provided.")
-        self._get_cavity_data(self.sweep_per_turn)
-        self._install_zeta_shift()
-        self.tw = self.line.twiss()
-        self.reset() # Initialize rf_sweep_df
-        self.env['rf_sweep'].dzeta = f"{self.L} * rf_sweep_df / ({self.f_RF} + rf_sweep_df)"
-        for cavs in self.cavities:
-            for cav in cavs['names']:
-                scale_factor = int(np.round(cavs['freq'] / self.f_RF))
-                if scale_factor == 1:
-                    self.env.ref[cav].frequency += self.env.ref["rf_sweep_df"]
-                else:
-                    self.env.ref[cav].frequency += scale_factor * self.env.ref["rf_sweep_df"]
-        self.line.enable_time_dependent_vars = True
-        print("Enabled time-dependent variables in the line.")
+    def prepare(self, *, sweep=None, num_turns=None, sweep_per_turn=None):
+        # TODO: if using sweep and num_turns, the sweep should stop after num_turns,
+        #       but if using sweep_per_turn, it should continue indefinitely.
+        if not self._prepared:
+            if sweep_per_turn is not None:
+                if np.isclose(sweep_per_turn, 0):
+                    raise ValueError("Variable `sweep_per_turn` must be non-zero!")
+                if sweep is not None:
+                    raise ValueError("Provide either `sweep` or `sweep_per_turn`, not both.")
+                if num_turns is not None:
+                    raise ValueError("Variable `num_turns` cannot be set when using `sweep_per_turn`.")
+                self.sweep_per_turn = sweep_per_turn
+            elif sweep is not None:
+                if np.isclose(sweep, 0):
+                    raise ValueError("Variable `sweep` must be non-zero!")
+                if num_turns is None:
+                    num_turns = int(abs(sweep))
+                if num_turns <= 0:
+                    raise ValueError("When using `sweep`, `num_turns` must be a positive integer.")
+                self.sweep_per_turn = sweep / num_turns
+            else:
+                raise ValueError("Either `sweep` or `sweep_per_turn` must be provided.")
+            self._get_cavity_data()
+            self._install_zeta_shift()
+            self.tw = self.line.twiss()
+            self.reset() # Initialize rf_sweep_df
+            self.env['rf_sweep'].dzeta = f"{self.L} * rf_sweep_df / ({self.f_RF} + rf_sweep_df)"
+            for cavs in self.cavities:
+                for cav in cavs['names']:
+                    scale_factor = int(np.round(cavs['freq'] / self.f_RF))
+                    if scale_factor == 1:
+                        self.env.ref[cav].frequency += self.env.ref["rf_sweep_df"]
+                    else:
+                        self.env.ref[cav].frequency += scale_factor * self.env.ref["rf_sweep_df"]
+            self.line.enable_time_dependent_vars = True
+            print("Enabled time-dependent variables in the line.")
+            self._prepared = True
 
 
     def reset(self):
         if self.sweep_per_turn is None:
             raise ValueError("RFSweep not prepared. Call `prepare` first.")
-        t_turn = self.tw.T_rev0
+        t_turn = self.tw.T_rev0   # To start sweeping from turn 0
         current_time = self.env['t_turn_s']
         if current_time == 0:
             self.env['rf_sweep_df'] = f"(t_turn_s + {t_turn}) / {t_turn} * {self.sweep_per_turn}"
@@ -76,10 +83,12 @@ class RFSweep:
 
 
     def info(self, sweep=None, num_turns=None):
-        if sweep is not None:
-            raise DeprecationWarning("The `sweep` argument is deprecated.")
-        if num_turns is not None:
-            raise DeprecationWarning("The `num_turns` argument is deprecated.")
+        if sweep is not None or num_turns is not None:
+            if sweep is not None:
+                warn("The `sweep` argument is deprecated.", DeprecationWarning)
+            if num_turns is not None:
+                warn("The `num_turns` argument is deprecated.", DeprecationWarning)
+            self.prepare(sweep=sweep, num_turns=num_turns)
         if self.sweep_per_turn is None:
             raise ValueError("RFSweep not prepared. Call `prepare` first.")
         existing_sweep = self.current_sweep_value
@@ -98,8 +107,9 @@ class RFSweep:
         print(f"The current frequency is {self.f_RF + existing_sweep}Hz, adding "
             + f"{self.sweep_per_turn}Hz per turn.")
         print(f"This sweep will move the center of the bucket with \u0394\u03B4 = "
-            + f"{delta_shift} per turn.")
-        print(f"This implies one bucket shift every {bucket_turns} turns.")
+            + f"{delta_shift:.4} per turn.")
+        print(f"The bucket height is {bucket_height:.4}, so this implies the sweep "
+            + f"will shift one bucket every {round(bucket_turns, 2)} turns.")
         if self.tw.qs * bucket_turns < 3:
             print(f"Warning: This is a very fast sweep, moving ~1 bucket in "
                 + f"~{round(self.tw.qs * bucket_turns, 2)} synchrotron oscillations "
@@ -110,11 +120,14 @@ class RFSweep:
 
     # For backward compatibility
     def track(self, sweep=0, particles=None, num_turns=0, verbose=True, *args, **kwargs):
-        self.prepare(sweep, num_turns)
-        self.line.track(particles=particles, *args, **kwargs)
+        warn("Using RFSweep.track() is deprecated. Please use RFSweep.prepare() "
+           + "and then xt.Line.track().", DeprecationWarning)
+        self.prepare(sweep=sweep, num_turns=num_turns)
+        self.line.track(particles=particles, num_turns=num_turns, *args, **kwargs)
 
 
-    def _get_cavity_data(self, sweep):
+    def _get_cavity_data(self):
+        # Cavity data not yet extracted
         tt = self.line.get_table()
         tt_c = tt.rows[[nn for nn, ttt in zip(tt.name, tt.element_type)
                         if 'Cavity' in ttt and 'CrabCavity' not in ttt]]
@@ -145,8 +158,8 @@ class RFSweep:
                 raise ValueError(f"Cavity `{cav}` not found in the line!")
         idx  = np.argsort(freq)
         boundaries = np.where(~np.isclose(freq[idx][1:], freq[idx][:-1],
-                                          rtol=1e-8, atol=1e-12)
-                              )[0] + 1
+                                        rtol=1e-8, atol=1e-12)
+                            )[0] + 1
         groups = []
         for gidx in np.split(idx, boundaries):
             groups.append({
@@ -168,10 +181,9 @@ class RFSweep:
             print("Found multiple cavities with different frequencies:")
             for g in self.cavities:
                 print(f"{g['freq']}Hz  at {g['voltage']}V: {g['names']}")
-            print(r"The sweep ($\Delta f$ = " + f"{sweep}Hz per turn) will be "
-                + f"performed with respect to the highest voltage cavity at "
-                + f"{self.f_RF}Hz. The other cavities will be shifted "
-                + f"accordingly.")
+            print(r"The sweep will be performed with respect to the highest "
+                + f"voltage cavity at {self.f_RF}Hz. The other cavities will "
+                + f"be shifted accordingly.")
 
 
     def _install_zeta_shift(self):

{xcoll-0.6.3.dist-info → xcoll-0.6.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: xcoll
-Version: 0.6.3
+Version: 0.6.5
 Summary: Xsuite collimation package
 License: Apache-2.0
 Author: Frederik F. Van der Veken
@@ -22,7 +22,7 @@ Requires-Dist: ruamel-yaml (>=0.17.31,<0.18.15)
 Requires-Dist: xdeps (>=0.10.6)
 Requires-Dist: xobjects (>=0.5.2)
 Requires-Dist: xpart (>=0.23.1)
-Requires-Dist: xtrack (>=0.89.3)
+Requires-Dist: xtrack (>=0.90.1)
 Project-URL: Bug Tracker, https://github.com/xsuite/xsuite/issues
 Project-URL: Documentation, https://xsuite.readthedocs.io/
 Project-URL: Homepage, https://github.com/xsuite/xcoll

{xcoll-0.6.3.dist-info → xcoll-0.6.5.dist-info}/RECORD

@@ -10,13 +10,17 @@ xcoll/beam_elements/elements_src/emittance_monitor.h,sha256=vlHzQFoUjKQHWBmzpaSz
 xcoll/beam_elements/elements_src/everest_block.h,sha256=ITSzfiqwm8ZNIkAj_odQkAjKhPcdT8b0AUlq_uxtsqI,6562
 xcoll/beam_elements/elements_src/everest_collimator.h,sha256=fkD5GazVv2zlmqyb6s9zVNMq6baXeFb_pf7gg9TKjNc,9787
 xcoll/beam_elements/elements_src/everest_crystal.h,sha256=LISp_9NEWMIi5GvZ3LwPfeSbmsbXvHWcTqxW6eCCsiE,11951
+xcoll/beam_elements/elements_src/rf_sweep.h,sha256=eTPPSJvFrkoh9STI0hmmiozwMUL-TQVhz1mOZQhObWE,846
 xcoll/beam_elements/elements_src/transparent_collimator.h,sha256=pA_Fxx85N87iSbpHSjR2OSOx6JN9e38T1pOUKrC7zxs,4610
 xcoll/beam_elements/elements_src/transparent_crystal.h,sha256=DGX4uL0hpm4njOypoPuEWtMzYxnL9jQkf2ZrGaS0alI,4128
 xcoll/beam_elements/everest.py,sha256=iJva_S0OQnmG-qj7rIAiUCssu5WL_Qs5P_n6Qx-IWzo,9080
 xcoll/beam_elements/monitor.py,sha256=baMYT_PNya8KX35ReeMwk5Cm04ePUqiDF_s69L5GTX0,16968
+xcoll/beam_elements/sweep.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 xcoll/beam_elements/transparent.py,sha256=AZOWfH3dvsetL6DjQGejUgX7T18e_3omIIffG_1gwc0,2894
 xcoll/colldb.py,sha256=WaJC6gkDNVvxo65OhucTM6Fwo6pgRFHNnBnHSkiX7AQ,31054
-xcoll/general.py,sha256=4ksyfjB_QTQ5LHe22beup0CS-e0tu2HDyDX7yuwZxDM,534
+xcoll/general.py,sha256=RyE6HAGBJF0DRK5n4X3-2o4fbRQwBZIV-LRjUo5-n8A,534
+xcoll/general.py.orig,sha256=vIx4LhKIwbjcC8cyk6wtxrjuihDEF1THgzwb7_dpgJU,609
+xcoll/geometry.md,sha256=AARDOk5lZWFBAllX75UYMRywSYSB04FIlYWE0ra1t5c,1623
 xcoll/headers/checks.h,sha256=qdXsOTBOK1MwW6bdFF93j4yE648mcDtEv5rGN1w9sfk,1582
 xcoll/headers/particle_states.py,sha256=N8ehLtg99358I4RGCJ3sjuKCk2LVdGqgVx2xGoHrRdM,1959
 xcoll/initial_distribution.py,sha256=CHhqeCVjVOyaBWhfy2sDgLwIgtXZoqcTW-su-M2YByE,10989
@@ -27,10 +31,10 @@ xcoll/interaction_record/interaction_types.py,sha256=XTeg2dcImMpqhTqzkJKh6JYam2v
 xcoll/line_tools.py,sha256=JBySkKKZ-RGumqAZF_8PSQ3OV0M87P78NeQgbXAdFc4,16699
 xcoll/lossmap.py,sha256=HLdhej9tUjk36T5BulVWurJtfiNa61L_1X7-8kT6JoQ,28407
 xcoll/plot.py,sha256=27fYdXstPg3o8XyeBlPuD2yz0GR3dKkNWy4kO2BD9WA,4071
-xcoll/prebuild_kernels/__init__.py,sha256=HITO-StW6e3GujTvLzEFz2Y8bMDGnavVttwixVPgA-M,286
-xcoll/prebuild_kernels/element_inits.py,sha256=9Qm34JXN7F08inWzXP6g6DU57ypRbyqHYwPK9Oc9BC4,219
-xcoll/prebuild_kernels/elements.py,sha256=7P5cxZgjfeNmUNuDer372KgtjmhH39Kk1wReyKMhqig,456
-xcoll/rf_sweep.py,sha256=Rrx4SmvKq4cmrfCU_Cetqmzp8c_uVa_QpXU4_rt4k_U,8611
+xcoll/prebuilt_kernel_definitions/__init__.py,sha256=Dju9g0ME0F8FpFUZREyiEcd8rVyQqIro8_8LKqegTtk,291
+xcoll/prebuilt_kernel_definitions/element_inits.py,sha256=9Qm34JXN7F08inWzXP6g6DU57ypRbyqHYwPK9Oc9BC4,219
+xcoll/prebuilt_kernel_definitions/element_types.py,sha256=7P5cxZgjfeNmUNuDer372KgtjmhH39Kk1wReyKMhqig,456
+xcoll/rf_sweep.py,sha256=_astbQSE7kr5AbnxOFR3WhduTvhkM6NR26EqyPMQ9EQ,9508
 xcoll/scattering_routines/engine.py,sha256=1VCBEZLMd5orFo3sZqK51NrqbqELBVrbsz6bB2SXsFQ,22962
 xcoll/scattering_routines/environment.py,sha256=xZ8A7XfvSfpe8vYbM5oD5qbcp8Tuag5qWAI6VqgGUlA,12033
 xcoll/scattering_routines/everest/__init__.py,sha256=7lkkeZ1liBjXVHCuRpgzZI6ohzHVMj5uJBO792147XY,286
@@ -57,9 +61,9 @@ xcoll/scattering_routines/geometry/rotation.h,sha256=lO3RaQBys9r0ROMjR8T8Rr7UsIE
 xcoll/scattering_routines/geometry/segments.h,sha256=7nKnnin2ByxkKyaYwGvFaqgLQg5uBba4CdLHL7L3iQs,7667
 xcoll/scattering_routines/geometry/sort.h,sha256=b1MkFO2ddzv1fWGeQzsLuz46qo2pKyRSXHjoAEVU7Ts,5763
 xcoll/xaux.py,sha256=mh4E_jhaUFm2LOKawJ0b6X4zuz8JiJhx6w7GcnRgIXQ,2291
-xcoll-0.6.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-xcoll-0.6.3.dist-info/METADATA,sha256=kTXBtG7uiFxoFbGbikFmNyER0Ee2f7-ASiqsEKmYqC8,2953
-xcoll-0.6.3.dist-info/NOTICE,sha256=6DO_E7WCdRKc42vUoVVBPGttvQi4mRt9fAcxj9u8zy8,74
-xcoll-0.6.3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-xcoll-0.6.3.dist-info/entry_points.txt,sha256=fC9oojAU6WjKujnGBodo7ZcEeBGfSfeLPO5287echdY,26
-xcoll-0.6.3.dist-info/RECORD,,
+xcoll-0.6.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+xcoll-0.6.5.dist-info/METADATA,sha256=3HdRmdvs2oyskur291fR-oZf2lbRZAIRoX6fNyY0iuA,2953
+xcoll-0.6.5.dist-info/NOTICE,sha256=6DO_E7WCdRKc42vUoVVBPGttvQi4mRt9fAcxj9u8zy8,74
+xcoll-0.6.5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+xcoll-0.6.5.dist-info/entry_points.txt,sha256=fC9oojAU6WjKujnGBodo7ZcEeBGfSfeLPO5287echdY,26
+xcoll-0.6.5.dist-info/RECORD,,