xcoll 0.5.10__py3-none-any.whl → 0.5.12__py3-none-any.whl

xcoll/beam_elements/base.py

@@ -12,8 +12,8 @@ from ..interaction_record import InteractionRecord
 from ..general import _pkg_root
 
 
-OPEN_JAW = 3.
-OPEN_GAP = 999.
+OPEN_JAW = 3
+OPEN_GAP = 999
 
 
 class InvalidXcoll(xt.BeamElement):
@@ -659,6 +659,11 @@ class BaseCollimator(BaseBlock):
         self._nemitt_x = val
         self._apply_optics()
 
+    @property
+    def gemitt_x(self):
+        if self.nemitt_x is not None and self.optics_ready():
+            return self.nemitt_x / self.optics['beta_gamma_rel']
+
     @property
     def nemitt_y(self):
         if self._nemitt_y == 0:
@@ -674,6 +679,11 @@ class BaseCollimator(BaseBlock):
         self._nemitt_y = val
         self._apply_optics()
 
+    @property
+    def gemitt_y(self):
+        if self.nemitt_y is not None and self.optics_ready():
+            return self.nemitt_y / self.optics['beta_gamma_rel']
+
     @property
     def emittance(self):
         if self.nemitt_x is not None and self.nemitt_y is not None:
@@ -734,8 +744,8 @@ class BaseCollimator(BaseBlock):
             alfy = self.optics[self.align]['alfy'][0]
             betx = self.optics[self.align]['betx'][0]
             bety = self.optics[self.align]['bety'][0]
-            divx = -np.sqrt(self.nemitt_x/self.optics['beta_gamma_rel']/betx)*alfx
-            divy = -np.sqrt(self.nemitt_y/self.optics['beta_gamma_rel']/bety)*alfy
+            divx = -np.sqrt(self.gemitt_x/betx)*alfx
+            divy = -np.sqrt(self.gemitt_y/bety)*alfy
             if hasattr(self, '_cos_zL'):
                 if self.side != 'right':
                     return divx if abs(self.angle_L) < 1e-6 else divy
@@ -1256,6 +1266,10 @@ class BaseCrystal(BaseBlock):
     def nemitt_x(self, val):
         BaseCollimator.nemitt_x.fset(self, val)
 
+    @property
+    def gemitt_x(self):
+        return BaseCollimator.gemitt_x.fget(self)
+
     @property
     def nemitt_y(self):
         return BaseCollimator.nemitt_y.fget(self)
@@ -1264,6 +1278,10 @@ class BaseCrystal(BaseBlock):
     def nemitt_y(self, val):
         BaseCollimator.nemitt_y.fset(self, val)
 
+    @property
+    def gemitt_y(self):
+        return BaseCollimator.gemitt_y.fget(self)
+
     @property
     def emittance(self):
         return BaseCollimator.emittance.fget(self)

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.5.10'
+__version__ = '0.5.12'
 # ======================

xcoll/headers/particle_states.h

@@ -10,10 +10,10 @@
 #define  XC_LOST_ON_EVEREST_COLL    -331
 #define  XC_LOST_ON_EVEREST_CRYSTAL -332
 #define  XC_LOST_ON_FLUKA_BLOCK     -333
-#define  XC_LOST_ON_FLUKA           -334
+#define  XC_LOST_ON_FLUKA_COLL      -334
 #define  XC_LOST_ON_FLUKA_CRYSTAL   -335
 #define  XC_LOST_ON_GEANT4_BLOCK    -336
-#define  XC_LOST_ON_GEANT4          -337
+#define  XC_LOST_ON_GEANT4_COLL     -337
 #define  XC_LOST_ON_GEANT4_CRYSTAL  -338
 #define  XC_LOST_ON_ABSORBER        -340
 

xcoll/initial_distribution.py

@@ -57,8 +57,14 @@ def generate_pencil_on_collimator(line, name, num_particles, *, side='+-', penci
     if twiss is None:
         twiss = line.twiss()
 
-    # Is it converging or diverging?    # TODO: This might change with a tilt!!!!!!
-    is_converging  = twiss[f'alf{plane}', name] > 0
+    # Is it converging or diverging?
+    # TODO: dispersion might change this
+    # TODO: this should be checked jaw by jaw (we are currently checking the left jaw - watch out for sign of tilt of right jaw)
+    # TODO: skew collimators
+    tilt = coll.tilt[0] if isinstance(coll.tilt, list) else coll.tilt
+    betatron_angle = coll.gap * coll.divergence
+    tolerance_tilt = 1e-12 # 0.1 urad tolerance on jaw tilt  =>  we prioritise converging
+    is_converging = tilt + tolerance_tilt >= betatron_angle
     print(f"Collimator {name} is {'con' if is_converging else 'di'}verging.")
 
     beam_sizes = twiss.get_beam_covariance(nemitt_x=coll.nemitt_x, nemitt_y=coll.nemitt_y)
@@ -181,25 +187,21 @@ def _generate_4D_pencil_one_jaw(line, name, num_particles, plane, side, impact_p
     coll = line[name]
 
     if side == '+':
-        if is_converging:
-            if isinstance(coll, EverestCrystal):
-                pencil_pos = coll.jaw_U + impact_parameter
-            else:
-                pencil_pos = coll.jaw_LU + impact_parameter
+        if isinstance(coll, EverestCrystal):
+            # A pencil on the crystal should always be upstream
+            pencil_pos = coll.jaw_U + impact_parameter
         else:
-            if isinstance(coll, EverestCrystal):
-                pencil_pos = coll.jaw_D - impact_parameter
+            if is_converging:
+                pencil_pos = coll.jaw_LU + impact_parameter
             else:
                 pencil_pos = coll.jaw_LD + impact_parameter
     elif side == '-':
-        if is_converging:
-            if isinstance(coll, EverestCrystal):
-                pencil_pos = coll.jaw_U - impact_parameter
-            else:
-                pencil_pos = coll.jaw_RU - impact_parameter
+        if isinstance(coll, EverestCrystal):
+            # A pencil on the crystal should always be upstream
+            pencil_pos = coll.jaw_U - impact_parameter
         else:
-            if isinstance(coll, EverestCrystal):
-                pencil_pos = coll.jaw_D + impact_parameter
+            if is_converging:
+                pencil_pos = coll.jaw_RU - impact_parameter
             else:
                 pencil_pos = coll.jaw_RD - impact_parameter
 

xcoll/line_tools.py

@@ -33,7 +33,7 @@ class XcollScatteringAPI:
                     if nemitt_y is None:
                         nemitt_y = el.nemitt_y
                     if not np.isclose(el.nemitt_x, nemitt_x) \
-                    or not np.isclose(el.nemitt_x, nemitt_x):
+                    or not np.isclose(el.nemitt_y, nemitt_y):
                         raise ValueError("Not all collimators have the same "
                                     + "emittance. This is not supported.")
                 if hasattr(el, 'enable_scattering'):
@@ -78,7 +78,6 @@ class XcollCollimatorAPI:
 
         # Verify elements
         for el in elements:
-            print(el.__class__)
             assert isinstance(el, block_classes)
             el._tracking = False
 
@@ -243,7 +242,7 @@ class XcollCollimatorAPI:
         tw_upstream, tw_downstream = self.get_optics_at(names, twiss=twiss)
         beta_gamma_rel = self.line.particle_ref._xobject.gamma0[0]*self.line.particle_ref._xobject.beta0[0]
         for coll in names:
-            self.line[coll].assign_optics(name=coll, nemitt_x=nemitt_x, nemitt_y=nemitt_x, twiss_upstream=tw_upstream,
+            self.line[coll].assign_optics(name=coll, nemitt_x=nemitt_x, nemitt_y=nemitt_y, twiss_upstream=tw_upstream,
                                     twiss_downstream=tw_downstream, beta_gamma_rel=beta_gamma_rel)
 
     def open(self, names=None):
@@ -282,22 +281,22 @@ class XcollCollimatorAPI:
 
 def assign_optics_to_collimators(line, nemitt_x=None, nemitt_y=None, twiss=None):
     warn("The function xcoll.assign_optics_to_collimators() is deprecated and will be "
-       + "removed in the future. Please use line.scattering.assign_optics() instead.", FutureWarning)
+       + "removed in the future. Please use line.collimators.assign_optics() instead.", FutureWarning)
     line.collimators.assign_optics(nemitt_x=nemitt_x, nemitt_y=nemitt_y, twiss=twiss)
 
 def get_optics_at(names, *, twiss=None, line=None):
     warn("The function xcoll.get_optics_at() is deprecated and will be "
-       + "removed in the future. Please use line.scattering.get_optics_at() instead.", FutureWarning)
+       + "removed in the future. Please use line.collimators.get_optics_at() instead.", FutureWarning)
     return line.collimators.get_optics_at(names=names, twiss=twiss)
 
 def open_collimators(line, names=None):
     warn("The function xcoll.open_collimators() is deprecated and will be "
-       + "removed in the future. Please use line.scattering.open_collimators() instead.", FutureWarning)
+       + "removed in the future. Please use line.collimators.open_collimators() instead.", FutureWarning)
     line.collimators.open(names=names)
 
 def send_to_parking(line, names=None):
     warn("The function xcoll.send_to_parking() is deprecated and will be "
-       + "removed in the future. Please use line.scattering.send_to_parking() instead.", FutureWarning)
+       + "removed in the future. Please use line.collimators.send_to_parking() instead.", FutureWarning)
     line.collimators.to_parking(names=names)
 
 def enable_scattering(line):

xcoll/scattering_routines/engine.py

@@ -0,0 +1,403 @@
+# copyright ############################### #
+# This file is part of the Xcoll Package.   #
+# Copyright (c) CERN, 2024.                 #
+# ######################################### #
+
+import os
+import numpy as np
+import shutil
+
+import xobjects as xo
+import xpart as xp
+import xtrack as xt
+try:
+    # TODO: once xaux is in Xsuite keep only this
+    from xaux import ClassProperty, ClassPropertyMeta, FsPath, singleton
+except ImportError:
+    from ..xaux import ClassProperty, ClassPropertyMeta, FsPath, singleton
+
+
+class BaseEngineMeta(xo.hybrid_class.MetaHybridClass, ClassPropertyMeta):
+    pass
+
+@singleton
+class BaseEngine(xo.HybridClass, metaclass=BaseEngineMeta):
+    _xofields = {
+        '_particle_ref': xp.Particles,
+        '_seed':         xo.UInt64,
+        '_capacity':     xo.Int64,
+    }
+
+    _int32 = False
+    _element_classes = None
+    _only_protons = False
+    _uses_input_file = False
+    _uses_run_folder = False
+
+    def __init__(self, **kwargs):
+        if not self._initialised:
+            if np.any([key[0] != '_' for key in self._xofields.keys()]):
+                raise ValueError(f"All fields in `{self.__class__.__name__}._xofields` have "
+                               + f"to start with an underscore! This is to ensure to work "
+                               + f"correctly with `ClassProperty`.")
+            if '_xobject' not in kwargs:
+                # Initialise defaults
+                self._cwd = None
+                self._line = None
+                self._verbose = False
+                self._input_file = None
+                self._element_dict = {}
+                self._warning_given = False
+                self._tracking_initialised = False
+                kwargs.setdefault('_particle_ref', xp.Particles())
+                kwargs.setdefault('_seed', 0)
+                kwargs.setdefault('_capacity', 0)
+            filtered_kwargs = {}
+            remaining_kwargs = {}
+            for key, value in kwargs.items():
+                if key in self._xofields.keys() or key == '_xobject':
+                    filtered_kwargs[key] = value
+                else:
+                    remaining_kwargs[key] = value
+            super().__init__(**filtered_kwargs)
+            kwargs = remaining_kwargs
+            self._initialised = True
+        # Apply kwargs
+        for kk, vv in kwargs.items():
+            if not hasattr(self.__class__, kk):
+                raise ValueError(f"Invalid attribute {kk} for {self.__class__.__name__}!")
+            setattr(self, kk, vv)
+
+    def __del__(self, *args, **kwargs):
+        self.stop(warn=False)
+
+
+    def _warn(self, error=None):
+        if not self._warning_given:
+            print(f"Warning: Failed to import {self.__class__.__name__} environment "
+                + f" (did you compile?).\n{self.__class__.__name__.replace('Engine', '')} "
+                + f"elements will be installed but are not trackable.\n", flush=True)
+            if error:
+                print(error, flush=True)
+            self._warning_given = True
+
+
+    # ==================
+    # === Properties ===
+    # ==================
+
+
+    @ClassProperty
+    def name(cls):
+        return cls.__name__.replace('Engine', '').lower()
+
+    @ClassProperty
+    def verbose(cls):
+        return cls.get_self()._verbose
+
+    @verbose.setter
+    def verbose(cls, val):
+        cls.get_self()._verbose = val
+
+    @ClassProperty
+    def line(cls):
+        return cls.get_self()._line
+
+    @line.setter
+    def line(cls, val):
+        if not val is None and not isinstance(val, xt.Line):
+            raise ValueError("`line` has to be an xt.Line object!")
+        cls.get_self()._line = val
+
+    @line.deleter
+    def line(cls):
+        cls.get_self()._line = None
+
+    @ClassProperty
+    def particle_ref(cls):
+        self = cls.get_self()
+        initial = xp.Particles().to_dict()
+        current = self._particle_ref.to_dict()
+        if xt.line._dicts_equal(initial, current):
+            return None
+        else:
+            return self._particle_ref
+
+    @particle_ref.setter
+    def particle_ref(cls, val):
+        self = cls.get_self()
+        if val is None:
+            self._particle_ref = xp.Particles()
+        else:
+            if not isinstance(val, xp.Particles):
+                raise ValueError("`particle_ref` has to be an xp.Particles object!")
+            if val._capacity > 1:
+                raise ValueError("`particle_ref` has to be a single particle!")
+            if val.pdg_id[0] == 0:
+                if cls._only_protons:
+                    val.pdg_id[0] = xp.get_pdg_id_from_name('proton')
+                else:
+                    raise ValueError("`particle_ref` needs to have a valid pdg_id")
+            elif cls._only_protons and val.pdg_id[0] != xp.get_pdg_id_from_name('proton'):
+                raise ValueError("{cls.__name__} only supports protons!")
+            self._particle_ref = val
+
+    @particle_ref.deleter
+    def particle_ref(cls):
+        cls.get_self()._particle_ref = xp.Particles()
+
+    @ClassProperty
+    def capacity(cls):
+        self = cls.get_self()
+        if self._capacity == 0:
+            return None
+        else:
+            return int(self._capacity)
+
+    @capacity.setter
+    def capacity(cls, val):
+        if val is None:
+            val = 0
+        cls.get_self()._capacity = int(val)
+
+    @capacity.deleter
+    def capacity(cls):
+        raise ValueError("Not allowed.")
+
+    @ClassProperty
+    def seed(cls):
+        self = cls.get_self()
+        if self._seed == 0:
+            return None
+        else:
+            return self._seed
+
+    @seed.setter
+    def seed(cls, val):
+        if val is None:
+            val = 0
+        val = int(val)
+        if cls._int32:
+            new_val = np.uint32(val)
+        else:
+            new_val = np.uint64(val)
+        if new_val != val:
+            print(f"Warning: type change for seed {val}. Using {new_val}.")
+        cls.get_self()._seed = new_val
+
+    @seed.deleter
+    def seed(cls):
+        cls.get_self()._seed = 0
+
+    @ClassProperty
+    def input_file(cls):
+        return cls.get_self()._input_file
+
+
+    # ======================
+    # === Public Methods ===
+    # ======================
+
+
+    @classmethod
+    def start(cls, *, line=None, elements=None, names=None, cwd=None, seed=None,
+              particle_ref=None, input_file=None, **kwargs):
+        self = cls.get_self(**kwargs)
+        if self.is_running() is None:
+            raise NotImplementedError(f"Need to implement `is_running` for {cls.__name__}!")
+        elif self.is_running() is True:
+            if self.verbose:
+                print("Engine already running.", flush=True)
+            return
+
+        self._starting_engine = True  # We need this to allow changing the element settings which otherwise are locked
+        self._use_seed(seed)
+        self._use_line(line)
+        self._use_particle_ref(particle_ref)
+        self._sync_line_particle_ref()
+        self._get_elements(line=line, elements=elements, names=names)
+        self._set_cwd(cwd=cwd)
+        self._use_input_file(input_file=input_file, **kwargs)
+        self.clean_output_files()
+        self._starting_engine = False
+
+
+    @classmethod
+    def stop(cls, clean=False, **kwargs):
+        self = cls.get_self(**kwargs)
+        if hasattr(self, '_old_seed'):
+            self.seed = self._old_seed
+            del self._old_seed
+        if hasattr(self, '_old_line'):
+            self.line = self._old_line
+            del self._old_line
+        if hasattr(self, '_old_particle_ref'):
+            self.particle_ref = self._old_particle_ref
+            del self._old_particle_ref
+            self._sync_line_particle_ref()
+        if hasattr(self, '_old_cwd') and self._old_cwd is not None:
+            os.chdir(self._old_cwd)
+            del self._old_cwd
+        if clean:
+            self.clean_output_files(clean_all=True)
+        self._cwd = None
+        self._input_file = None
+        self._element_dict = {}
+        self._warning_given = False
+        self._tracking_initialised = False
+
+
+    @classmethod
+    def assert_particle_ref(cls, **kwargs):
+        if cls.get_self(**kwargs).particle_ref is None:
+            raise ValueError(f"{cls.__name__} reference particle not set!")
+
+
+    # =======================
+    # === Private Methods ===
+    # =======================
+
+    # For all the following fields, they can either be set in advance on the engine,
+    # or they can be set when the engine is started. In the latter case, the values
+    # are temporary and the original will be restored when the engine is stopped.
+
+    def _use_line(self, line=None):
+        self._old_line = self.line
+        self.line = line
+
+    def _use_seed(self, seed=None):
+        self._old_seed = self.seed
+        if seed is not None:
+            self.seed = seed
+        else:
+            if self.seed is None:
+                if self._int32:
+                    self.seed = np.random.randint(0, int(2**32))
+                else:
+                    self.seed = np.random.randint(0, int(2**64))
+        if self.verbose:
+            print(f"Using seed {self.seed}.")
+
+    def _use_particle_ref(self, particle_ref=None):
+        # Prefer: provided particle_ref > existing particle_ref > particle_ref from line
+        self._old_particle_ref = self.particle_ref
+        if particle_ref is not None:
+            self.particle_ref = particle_ref
+        elif self.particle_ref is None:
+            if self.line is None or not hasattr(self.line, 'particle_ref') \
+            or self.line.particle_ref is None:
+                raise ValueError("Need to provide either a line with a reference "
+                               + "particle, or `particle_ref`.")
+            self.particle_ref = self.line.particle_ref
+        if self.verbose:
+            print(f"Using {xp.get_name_from_pdg_id(self.particle_ref.pdg_id[0])}.")
+
+    def _sync_line_particle_ref(self):
+        if self.line is None:
+            return
+        if self.line.particle_ref is not None \
+        and not xt.line._dicts_equal(self.line.particle_ref.to_dict(),
+                                     self.particle_ref.to_dict()):
+            overwrite_particle_ref_in_line = True
+        if overwrite_particle_ref_in_line:
+            print("Warning: Found different reference particle in line! Temporarily overwritten.")
+            self.line.particle_ref = self.particle_ref
+
+    def _get_elements(self, line=None, elements=None, names=None):
+        if self._element_classes is None:
+            raise NotImplementedError(f"{self.__class__.__name__} needs to define `_element_classes`!")
+        if line is None:
+            if elements is None:
+                raise ValueError("Need to provide either `line` or `elements`.")
+            if not hasattr(elements, '__iter__') or isinstance(elements, str):
+                elements = [elements]
+            if names is None:
+                names = [f"{self.__class__.name}_el_{i}" for i, _ in enumerate(elements)]
+            else:
+                if not hasattr(names, '__iter__') or isinstance(names, str):
+                    names = [names]
+                if len(names) != len(elements):
+                    raise ValueError("Length of `elements` and `names` doesn't match.")
+        else:
+            if elements is not None:
+                raise ValueError("Cannot provide both `line` and `elements`.")
+            if names is None:
+                elements, names = line.get_elements_of_type(self._element_classes)
+            else:
+                if not hasattr(names, '__iter__') or isinstance(names, str):
+                    names = [names]
+                elements = [line[name] for name in names]
+        elements = [el for el in elements if el.active and el.jaw is not None]
+        names    = [name for el, name in zip(elements,names) if el.active and el.jaw is not None]
+        for el in elements:
+            if not isinstance(el, self._element_classes):
+                raise ValueError(f"Element {el} is not a "
+                                + ", or a ".join([c.__name__ for c in self._element_classes])
+                                + ".")
+        if len(elements) == 0:
+            raise ValueError(f"No active {self.name} elements found!")
+        self._element_dict = dict(zip(names, elements))
+
+    def _set_cwd(self, cwd):
+        if self._uses_run_folder:
+            if cwd is not None:
+                cwd = FsPath(cwd).expanduser().resolve()
+            else:
+                # TODO: use xaux.ranID here
+                import base64
+                ran = base64.urlsafe_b64encode(os.urandom(8)).decode('utf-8')
+                ran_str = ''.join(c if c.isalnum() else 'X' for c in ran)
+                cwd = FsPath.cwd() / f'{self.name}_run_{ran_str}'
+            self._cwd = cwd
+            cwd.mkdir(parents=True, exist_ok=True)
+            self._old_cwd = FsPath.cwd()
+            os.chdir(cwd)
+
+    def _use_input_file(self, input_file=None, **kwargs):
+        if self._uses_input_file:
+            if input_file is None:
+                if not hasattr(self, 'generate_input_file'):
+                    raise NotImplementedError("Need to implement `generate_input_file`"
+                                              "for {cls.__name__}!")
+                input_file = self.generate_input_file(**kwargs)
+            if not hasattr(input_file, '__iter__') or isinstance(input_file, str):
+                # Some engines might need multiple input files (like Fluka)
+                input_file = [input_file]
+            input_file = [FsPath(f).expanduser().resolve() for f in input_file]
+            new_files = []
+            for file in input_file:
+                if not file.exists():
+                    raise ValueError(f"Input file {file.as_posix()} not found!")
+                if file.parent != FsPath.cwd():
+                    shutil.copy(file, FsPath.cwd())
+                    new_files.append(FsPath.cwd() / file.name)
+                else:
+                    new_files.append(file)
+            self._input_file = new_files[0] if len(new_files)==1 else new_files
+            self._match_input_file()
+
+
+    # ===============================
+    # === Methods to be inherited ===
+    # ===============================
+
+    @classmethod
+    def is_running(cls, **kwargs):
+        self = cls.get_self(**kwargs)
+        if hasattr(self, '_starting_engine') and self._starting_engine:
+            # We need this to allow changing the element settings which otherwise are locked
+            return False
+        # If we get here, we cannot say if the engine is running or not and we need an
+        # implementation in the child class
+        return None
+
+    @classmethod
+    def clean_output_files(cls, **kwargs):
+        pass
+
+    def _match_input_file(self, **kwargs):
+        raise NotImplementedError("Need to implement `_match_input_file` for {cls.__name__}!")
+
+    @classmethod
+    def generate_input_file(cls, **kwargs):
+        raise NotImplementedError("Need to implement `generate_input_file` for {cls.__name__}!")

xcoll/scattering_routines/everest/properties.h

@@ -171,7 +171,7 @@ double calculate_dechanneling_length(EverestData restrict everest, double pc) {
     double energy   = sqrt(pow(momentum, 2.) + pow(XC_PROTON_MASS, 2.)); // [MeV]
     double gammar   = energy/XC_PROTON_MASS;
 
-    double const_dech = 256.0/(9.*pow(M_PI, 2.)) / (log(2.*XC_ELECTRON_MASS*gammar/exenergy) - 1.);
+    double const_dech = 256.0/(9.*pow(M_PI, 2.)) / (log(2.*XC_ELECTRON_MASS*gammar/exenergy/1000) - 1.);
     const_dech       *= (XC_SCREENING*XC_PLANE_DISTANCE)/(XC_CRADE*XC_ELECTRON_MASS)*1.0e3; // [m/GeV]
     return const_dech;
 }

xcoll/xaux.py

@@ -0,0 +1,117 @@
+# copyright ############################### #
+# This file is part of the Xcoll Package.   #
+# Copyright (c) CERN, 2024.                 #
+# ######################################### #
+
+import functools
+from pathlib import Path
+
+FsPath = Path
+
+
+def singleton(cls):
+    # Store the original __new__ method if it exists
+    original_new = cls.__new__ if hasattr(cls, '__new__') else None
+
+    # Define a new __new__ method for the singleton
+    def singleton_new(cls, *args, **kwargs):
+        if not hasattr(cls, 'instance'):
+            cls.instance = (original_new(cls, *args, **kwargs)
+                            if original_new
+                            else super(cls, cls).__new__(cls))
+            cls.instance._initialised = False
+        return cls.instance
+    cls.__new__ = singleton_new
+
+    # Define the get_self method
+    @classmethod
+    def get_self(cls, **kwargs):
+        # Filter kwargs to include only ClassProperty attributes
+        filtered_kwargs = {key: value for key, value in kwargs.items()
+                           if key in ClassProperty.get_properties(cls) or
+                           key in getattr(cls, '_xofields', {})}
+        return cls(**filtered_kwargs)
+    cls.get_self = get_self
+
+    return cls
+
+
+
+class ClassPropertyMeta(type):
+    def __setattr__(cls, key, value):
+        # Check if the attribute is a ClassProperty
+        for parent in cls.__mro__:
+            if key in parent.__dict__ and isinstance(parent.__dict__[key], ClassProperty):
+                return parent.__dict__[key].__set__(cls, value)
+        return super(ClassPropertyMeta, cls).__setattr__(key, value)
+
+
+class ClassProperty:
+    _registry = {}  # Registry to store ClassProperty names for each class
+
+    @classmethod
+    def get_properties(cls, owner, parents=True):
+        if not parents:
+            return cls._registry.get(owner, [])
+        else:
+            return [prop for parent in owner.__mro__
+                         for prop in cls._registry.get(parent, [])]
+
+    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
+        functools.update_wrapper(self, fget)
+        self.fget = fget
+        self.fset = fset
+        self.fdel = fdel
+        if doc is None and fget is not None:
+            doc = fget.__doc__
+        self.__doc__ = doc
+
+    def __set_name__(self, owner, name):
+        self.name = name
+        # Verify that the class is a subclass of ClassPropertyMeta
+        if ClassPropertyMeta not in type(owner).__mro__:
+            raise AttributeError(f"Class `{owner.__name__}` must be a subtype of ClassPropertyMeta!")
+        # Add the property name to the registry for the class
+        if owner not in ClassProperty._registry:
+            ClassProperty._registry[owner] = []
+        ClassProperty._registry[owner].append(name)
+        # Create default getter, setter, and deleter
+        if self.fget is None:
+            def _getter(*args, **kwargs):
+                raise AttributeError(f"Unreadable attribute `{name}` for class {owner.__name__}!")
+            self.fget = _getter
+        if self.fset is None:
+            def _setter(self, *args, **kwargs):
+                raise AttributeError(f"Can't set attribute `{name}` for class {owner.__name__}!")
+            self.fset = _setter
+        if self.fdel is None:
+            def _deleter(*args, **kwargs):
+                raise AttributeError(f"Can't delete attribute `{name}` for class {owner.__name__}!")
+            self.fdel = _deleter
+
+    def __get__(self, instance, owner):
+        if owner is None:
+            owner = type(instance)
+        try:
+            return self.fget(owner)
+        except ValueError:
+            # Return a fallback if initialization fails
+            return None
+
+    def __set__(self, cls, value):
+        self.fset(cls, value)
+
+    def __delete__(self, instance):
+        self.fdel(instance.__class__)
+
+    def getter(self, fget):
+        self.fget = fget
+        return self
+
+    def setter(self, fset):
+        self.fset = fset
+        return self
+
+    def deleter(self, fdel):
+        self.fdel = fdel
+        return self

{xcoll-0.5.10.dist-info → xcoll-0.5.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xcoll
-Version: 0.5.10
+Version: 0.5.12
 Summary: Xsuite collimation package
 Home-page: https://github.com/xsuite/xcoll
 License: Apache 2.0
@@ -18,10 +18,10 @@ Provides-Extra: tests
 Requires-Dist: numpy (>=1.0)
 Requires-Dist: pandas (>=1.4)
 Requires-Dist: ruamel-yaml (>=0.17.31,<0.18.0) ; extra == "tests"
-Requires-Dist: xdeps (>=0.7.4)
-Requires-Dist: xobjects (>=0.4.5)
-Requires-Dist: xpart (>=0.19.1)
-Requires-Dist: xtrack (>=0.69.7)
+Requires-Dist: xdeps (>=0.8.4)
+Requires-Dist: xobjects (>=0.4.6)
+Requires-Dist: xpart (>=0.19.3)
+Requires-Dist: xtrack (>=0.72.2)
 Project-URL: Repository, https://github.com/xsuite/xcoll
 Description-Content-Type: text/markdown
 

{xcoll-0.5.10.dist-info → xcoll-0.5.12.dist-info}/RECORD

@@ -4,7 +4,7 @@ xcoll/__init__.py,sha256=b_61vh5irhf5fPmqTFJlyhNSt4rmftXg9uXPIEpgVB4,1612
 xcoll/_manager.py,sha256=9NQKaNxZR2I1ChMVBeKQc0A8h6W8gVgRRg72a5NgbXU,808
 xcoll/beam_elements/__init__.py,sha256=06bU8rzvlUPhcvwpaUippddm5IChpcCHBvpmvXJQU74,1122
 xcoll/beam_elements/absorber.py,sha256=efK6gyUgD4x_FnBLpMR7-5_HCdp_753nkYikcdn6ulw,2502
-xcoll/beam_elements/base.py,sha256=5k4ngEXNgvoiJWu7dx2bwHlv73tfaxn-4JlCdLwHdYo,53495
+xcoll/beam_elements/base.py,sha256=J69dwAILHGwGthaQK3D9f2Etibv6fe11oczcKftTEac,53943
 xcoll/beam_elements/blowup.py,sha256=gBXdlISvoDiMjXVpA77ls5QdAU3H9krwvFt2bSW_NII,8029
 xcoll/beam_elements/elements_src/black_absorber.h,sha256=jCyQoaZ7VsIu8coQ99J1dDtAGqZpFIxxFLBlfhO6Drw,5027
 xcoll/beam_elements/elements_src/black_crystal.h,sha256=x7oUwsrkUwUrFvhFsq8vtPkJJTSi1hYAhSt6fjzkJQo,4622
@@ -16,18 +16,19 @@ xcoll/beam_elements/elements_src/everest_crystal.h,sha256=WwwNF6it7TuOimhpSXJa7U
 xcoll/beam_elements/everest.py,sha256=PA_VWpnPrIuO1xN__eKyT_ejbGZK7p93QHDVi3re7cM,8541
 xcoll/beam_elements/monitor.py,sha256=zzMdN3JMFSAs-30_ntRvd5qZGdsXfGtColhiFDuMcIk,16928
 xcoll/colldb.py,sha256=hGScl4lU93KDemHrgHOKfu2OqVAufP1BtgKKHJ_THDc,30501
-xcoll/general.py,sha256=wIlggzlMxO2sa0ntCbJyJatOL4CSQ7ndh3Ff9SNuOsc,535
+xcoll/general.py,sha256=VqLfCrl6mLRBUaBR8TC0bGG8MH271fZEGKITEw3UfYo,535
 xcoll/headers/checks.h,sha256=qdXsOTBOK1MwW6bdFF93j4yE648mcDtEv5rGN1w9sfk,1582
-xcoll/headers/particle_states.h,sha256=DZa_ZSaJrjnA8aHFriZKfRCkArQ8nK1t445MRwevDtA,840
-xcoll/initial_distribution.py,sha256=x5G4LTXn4boEg5jBFrQCk_l759h91XiAUhDTdcUvLkc,8779
+xcoll/headers/particle_states.h,sha256=9hzp5abC_pIV6QrHy0iNm0qblcvsymI-pJQMv6v1Rhc,840
+xcoll/initial_distribution.py,sha256=yjjEk2PJjE1YB9xDMeVDa-qFVlPTvVWEf8yynHvgAow,9015
 xcoll/install.py,sha256=SxEFQnhWXlsXyPBIo847q6wPgId_f5ZtFRR1awGbkjc,2108
 xcoll/interaction_record/__init__.py,sha256=UFoLiKa-z2oX7YoszP-7Vgdt1nM6kT382v1CaIu8_u0,50
 xcoll/interaction_record/interaction_record.py,sha256=ixsQtVZn71vVEuTAA27a2NWcZZZ8iAcWFOa58bcWEQU,13271
 xcoll/interaction_record/interaction_record_src/interaction_record.h,sha256=0rNagnfSGc2i1jauOMIcDbj9QFic9dV_MOyqVx1kw5Q,6067
 xcoll/interaction_record/interaction_types.py,sha256=Vh6oFYKdRNOx9hc_E0iT8auNZVKC0qYVp_p7oyClZ8o,2894
-xcoll/line_tools.py,sha256=UtRVlwX1T-wzocFzgb3VoJuBavvggNnYONjvP2WigKM,14326
+xcoll/line_tools.py,sha256=ZVUNRP_UI9RP7PBYBUVegww4J_BmdSo2dn3BS4ZAohI,14298
 xcoll/lossmap.py,sha256=W2EzOe4aKmJFd8kEpebeQaAn1818QF3ih_nhA_br-2I,8062
 xcoll/rf_sweep.py,sha256=P2X1S9pGi4OpNYnzYfQVyblFt2p8aw9EWHsKDkAuYt0,8936
+xcoll/scattering_routines/engine.py,sha256=ZE2a_RbjGvoRZEr6XNGa6avsB_faiIqPBqb7SVWZyng,15018
 xcoll/scattering_routines/everest/__init__.py,sha256=7lkkeZ1liBjXVHCuRpgzZI6ohzHVMj5uJBO792147XY,286
 xcoll/scattering_routines/everest/amorphous.h,sha256=0eSV8F7yb2xrhrEGPZGWu_Lgr3gjtU8RddaJElsZ-Tk,10362
 xcoll/scattering_routines/everest/channeling.h,sha256=k7ohwPec3gk3WCvwm-0C8cB39F__CO2yLyvKCWCg714,11050
@@ -39,7 +40,7 @@ xcoll/scattering_routines/everest/jaw.h,sha256=BWpfrHNPLaMF8JjsNAhWwy6TDI0jsiOT3
 xcoll/scattering_routines/everest/materials.py,sha256=nO0ZayGRgqgF7Eku-mtxDl0BPOls5YS8a0qPPG32qw0,10260
 xcoll/scattering_routines/everest/multiple_coulomb_scattering.h,sha256=NgrUEX-zCaiS1mwJvMLhfmg8GPNcPSGzh6UQKYqphJ8,5432
 xcoll/scattering_routines/everest/nuclear_interaction.h,sha256=jr49uo2cCk5SiebMZtb_If2WFHSxNLpYYKDJiQbhW1g,3110
-xcoll/scattering_routines/everest/properties.h,sha256=mVPntq9lgZPnJdtOJDi_tSawecBPLB09b7BKbisPe7w,6774
+xcoll/scattering_routines/everest/properties.h,sha256=9kf-a8EYGTVVZPkIzI-YXLW3ZvKEAJvACB8eSpcD2dM,6779
 xcoll/scattering_routines/fluka/flukaio/.git,sha256=5ZxurpwP1waJk2Zu2AstENGOp4rXU8-C-oU4CypmIVI,73
 xcoll/scattering_routines/fluka/flukaio/.gitignore,sha256=bhrpWiAnKChkcwIaIPX_zKxyG2nCtNzNgQAHnIJa8Fw,12
 xcoll/scattering_routines/fluka/flukaio/CMakeLists.txt,sha256=iWWqTC26UqcuQWQj_JCKtX6iiOb7arnhQ9kOo1fDVkE,591
@@ -406,8 +407,9 @@ xcoll/scattering_routines/geometry/objects.h,sha256=A5ktGvVlSkC4hUsI_PQFsE80CuDw
 xcoll/scattering_routines/geometry/rotation.h,sha256=lO3RaQBys9r0ROMjR8T8Rr7UsIEm-H9_C_70Nwz4MXY,701
 xcoll/scattering_routines/geometry/segments.h,sha256=7nKnnin2ByxkKyaYwGvFaqgLQg5uBba4CdLHL7L3iQs,7667
 xcoll/scattering_routines/geometry/sort.h,sha256=b1MkFO2ddzv1fWGeQzsLuz46qo2pKyRSXHjoAEVU7Ts,5763
-xcoll-0.5.10.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-xcoll-0.5.10.dist-info/METADATA,sha256=QjZzi_xm9l64o5NVMUqkX5E0Tn5RrbW4pJbGMdqyrPI,2676
-xcoll-0.5.10.dist-info/NOTICE,sha256=6DO_E7WCdRKc42vUoVVBPGttvQi4mRt9fAcxj9u8zy8,74
-xcoll-0.5.10.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-xcoll-0.5.10.dist-info/RECORD,,
+xcoll/xaux.py,sha256=KME-8QXkZwQLqgtuC2q7KM27WCCBDLWHR9zq7uVaMlc,4085
+xcoll-0.5.12.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+xcoll-0.5.12.dist-info/METADATA,sha256=Ag2SZen5Cuuvjz6ZoIZjvxluHWDkaDEgsxVC4XLU9Io,2676
+xcoll-0.5.12.dist-info/NOTICE,sha256=6DO_E7WCdRKc42vUoVVBPGttvQi4mRt9fAcxj9u8zy8,74
+xcoll-0.5.12.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+xcoll-0.5.12.dist-info/RECORD,,