Merge pull request #115 from xsuite/release/v0.5.7

Release 0.5.7

Author: freddieknets

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "xcoll"
-version = "0.5.6"
+version = "0.5.7"
 description = "Xsuite collimation package"
 homepage = "https://github.com/xsuite/xcoll"
 repository = "https://github.com/xsuite/xcoll"

tests/test_version.py

@@ -6,4 +6,4 @@
 from xcoll import __version__
 
 def test_version():
-    assert __version__ == '0.5.6'
+    assert __version__ == '0.5.7'

xcoll/beam_elements/__init__.py

@@ -20,8 +20,3 @@
                         if isinstance(v, type) and issubclass(v, BaseCrystal) and v != BaseCrystal)
 
 element_classes = block_classes + (BlowUp, EmittanceMonitor)
-
-# For compatibility with _K2Collimators
-_all_block_classes      = block_classes
-_all_collimator_classes = collimator_classes
-_all_crystal_classes    = crystal_classes

xcoll/beam_elements/base.py

@@ -597,9 +597,6 @@ def optics_ready(self):
 
     def assign_optics(self, *, nemitt_x=None, nemitt_y=None, beta_gamma_rel=None, name=None, twiss=None,
                       twiss_upstream=None, twiss_downstream=None):
-        from xcoll.beam_elements import _all_collimator_classes
-        if not isinstance(self, _all_collimator_classes):
-            raise ValueError("Please install collimator before assigning optics.")
         if nemitt_x is None:
             if self.nemitt_x is None:
                 raise ValueError("Need to provide `nemitt_x`.")

xcoll/colldb.py

@@ -13,7 +13,7 @@
 import xtrack as xt
 
 from .beam_elements import BlackAbsorber, BlackCrystal, EverestCollimator, EverestCrystal, \
-                           BaseCollimator, BaseCrystal, _all_collimator_classes
+                           BaseCollimator, BaseCrystal, collimator_classes
 from .scattering_routines.everest.materials import SixTrack_to_xcoll
 
 
@@ -526,7 +526,7 @@ def _get_names_from_line(self, line, names, families):
     def _check_installed(self, line, name, collimator_class):
             # Check that collimator is not installed as different type
             # TODO: automatically replace collimator type and print warning
-            if isinstance(line[name], _all_collimator_classes):
+            if isinstance(line[name], collimator_classes):
                 raise ValueError(f"Trying to install {name} as {collimator_class.__name__}, "
                                + f"but it is already installed as {line[name].__class__.__name__}!\n"
                                + f"Please reconstruct the line.")

xcoll/general.py

@@ -12,5 +12,5 @@
 # ======================
 # Do not change
 # ======================
-__version__ = '0.5.6'
+__version__ = '0.5.7'
 # ======================

xcoll/initial_distribution.py

@@ -10,7 +10,7 @@
 import xobjects as xo
 import xpart as xp
 
-from .beam_elements import _all_collimator_classes, EverestCrystal
+from .beam_elements import collimator_classes, EverestCrystal
 
 
 def generate_pencil_on_collimator(line, name, num_particles, *, side='+-', pencil_spread=1e-6,
@@ -25,7 +25,7 @@ def generate_pencil_on_collimator(line, name, num_particles, *, side='+-', penci
 
     coll = line[name]
 
-    if not isinstance(coll, tuple(_all_collimator_classes)):
+    if not isinstance(coll, tuple(collimator_classes)):
         raise ValueError("Need to provide a valid collimator!")
 
     if coll.optics is None:

xcoll/line_tools.py

@@ -8,7 +8,7 @@
 
 import xtrack as xt
 
-from .beam_elements import element_classes, _all_collimator_classes, _all_block_classes
+from .beam_elements import element_classes, collimator_classes, block_classes
 
 
 class XcollScatteringAPI:
@@ -79,7 +79,7 @@ def install(self, names, elements, *, at_s=None, apertures=None, need_apertures=
         # Verify elements
         for el in elements:
             print(el.__class__)
-            assert isinstance(el, _all_block_classes)
+            assert isinstance(el, block_classes)
             el._tracking = False
 
         # Get positions
@@ -239,7 +239,7 @@ def assign_optics(self, *, nemitt_x=None, nemitt_y=None, twiss=None, tw=None):
                 twiss = tw
         if not self.line._has_valid_tracker():
             raise Exception("Please build tracker before setting the openings!")
-        names = self.line.get_elements_of_type(_all_collimator_classes, _all_block_classes)[1]
+        names = self.line.get_elements_of_type(collimator_classes)[1]
         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:
@@ -248,7 +248,7 @@ def assign_optics(self, *, nemitt_x=None, nemitt_y=None, twiss=None, tw=None):
 
     def open(self, names=None):
         if names is None:
-            names = self.line.get_elements_of_type(_all_collimator_classes, _all_block_classes)[1]
+            names = self.line.get_elements_of_type(collimator_classes)[1]
         if len(names) == 0:
             print("No collimators found in line.")
         else:
@@ -258,7 +258,7 @@ def open(self, names=None):
 
     def to_parking(self, names=None):
         if names is None:
-            names = self.line.get_elements_of_type(_all_collimator_classes)[1]
+            names = self.line.get_elements_of_type(collimator_classes)[1]
         if len(names) == 0:
             print("No collimators found in line.")
         else:

xcoll/lossmap.py

@@ -12,7 +12,7 @@
 import xpart as xp
 import xobjects as xo
 
-from .beam_elements import _all_collimator_classes, _all_crystal_classes
+from .beam_elements import collimator_classes, crystal_classes
 
 
 class LossMap:
@@ -114,7 +114,7 @@ def weights(self):
     def _correct_absorbed(self, verbose=True):
         # Correct particles that are at an aperture directly after a collimator
         part = self._part
-        coll_classes = list(set(_all_collimator_classes) - set(_all_crystal_classes))
+        coll_classes = list(set(collimator_classes) - set(crystal_classes))
         coll_elements = self._line.get_elements_of_type(coll_classes)[1]
         for idx, elem in enumerate(part.at_element):
             if part.state[idx] == 0:
@@ -156,7 +156,7 @@ def _interpolate(self):
 
 
     def _make_coll_summary(self):
-        collimator_names = self._line.get_elements_of_type(_all_collimator_classes)[1]
+        collimator_names = self._line.get_elements_of_type(collimator_classes)[1]
         coll_mask     = (self._part.state <= -330) & (self._part.state >= -340)
         coll_losses   = np.array([self._line.element_names[i]
                                   for i in self._part.at_element[coll_mask]])