xcoll 0.5.4__py3-none-any.whl → 0.5.5__py3-none-any.whl

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.4'
+__version__ = '0.5.5'
 # ======================

xcoll/line_tools.py

@@ -4,84 +4,131 @@
 # ######################################### #
 
 import numpy as np
+import warnings
+warnings.simplefilter("always")
+
 import xtrack as xt
 
 from .beam_elements import element_classes, _all_collimator_classes
 
 
-class XcollLineAPI:
+class XcollCollimatorAPI:
+    def __init__(self, line):
+        self._line = line
+
+    @property
+    def line(self):
+        return self._line
+
+
+    def get_optics_at(self, names, *, twiss=None):
+        if twiss is None:
+            if not self.line._has_valid_tracker():
+                raise Exception("Please build the tracker before computing the optics for the openings!")
+            twiss = self.line.twiss()
+        if not hasattr(names, '__iter__') and not isinstance(names, str):
+            names = [names]
+        coll_entry_indices = twiss.rows.indices[names]
+        tw_entry = twiss.rows[coll_entry_indices]
+        tw_exit = twiss.rows[coll_entry_indices+1]
+        tw_exit.name = tw_entry.name
+        return tw_entry, tw_exit
+
+    def assign_optics(self, nemitt_x=None, nemitt_y=None, twiss=None):
+        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)[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:
+            self.line[coll].assign_optics(name=coll, nemitt_x=nemitt_x, nemitt_y=nemitt_x, twiss_upstream=tw_upstream,
+                                    twiss_downstream=tw_downstream, beta_gamma_rel=beta_gamma_rel)
+
+    def open(self, names=None):
+        if names is None:
+            names = self.line.get_elements_of_type(_all_collimator_classes)[1]
+        if len(names) == 0:
+            print("No collimators found in line.")
+        else:
+            for coll in names:
+                self.line[coll].open_jaws(keep_tilts=False)
+                self.line[coll].gap = None
+
+    def to_parking(self, names=None):
+        if names is None:
+            names = self.line.get_elements_of_type(_all_collimator_classes)[1]
+        if len(names) == 0:
+            print("No collimators found in line.")
+        else:
+            raise NotImplementedError("Need to move this to new type manager or so.")
+
+
+class XcollScatteringAPI:
     def __init__(self, line):
         self._line = line
 
+    @property
+    def line(self):
+        return self._line
+
+    def enable(self):
+        elements = self.line.get_elements_of_type(element_classes)[0]
+        if len(elements) == 0:
+            print("No xcoll elements found in line.")
+        else:
+            nemitt_x = None
+            nemitt_y = None
+            for el in elements:
+                if hasattr(el, 'optics') and el.optics is not None:
+                    if nemitt_x is None:
+                        nemitt_x = el.nemitt_x
+                    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):
+                        raise ValueError("Not all collimators have the same "
+                                    + "emittance. This is not supported.")
+                if hasattr(el, 'enable_scattering'):
+                    el.enable_scattering()
+
+    def disable(self):
+        elements = self.line.get_elements_of_type(element_classes)[0]
+        if len(elements) == 0:
+            print("No xcoll elements found in line.")
+        else:
+            for el in elements:
+                if hasattr(el, 'disable_scattering'):
+                    el.disable_scattering()
+
+
+
 
 def assign_optics_to_collimators(line, nemitt_x=None, nemitt_y=None, twiss=None):
-    if not line._has_valid_tracker():
-        raise Exception("Please build tracker before setting the openings!")
-    names = line.get_elements_of_type(_all_collimator_classes)[1]
-    tw_upstream, tw_downstream = get_optics_at(names, twiss=twiss, line=line)
-    beta_gamma_rel = line.particle_ref._xobject.gamma0[0]*line.particle_ref._xobject.beta0[0]
-    for coll in names:
-        line[coll].assign_optics(name=coll, nemitt_x=nemitt_x, nemitt_y=nemitt_x, twiss_upstream=tw_upstream,
-                                 twiss_downstream=tw_downstream, beta_gamma_rel=beta_gamma_rel)
+    warnings.warn("The function xcoll.assign_optics_to_collimators() is deprecated and will be "
+                + "removed in the future. Please use line.scattering.assign_optics() instead.", DeprecationWarning)
+    line.collimators.assign_optics(nemitt_x=nemitt_x, nemitt_y=nemitt_y, twiss=twiss)
 
 def get_optics_at(names, *, twiss=None, line=None):
-    if twiss is None:
-        if not line._has_valid_tracker():
-            raise Exception("Please pass a line and build tracker before computing the optics for the openings!")
-        twiss = line.twiss()
-    if not hasattr(names, '__iter__') and not isinstance(names, str):
-        names = [names]
-    coll_entry_indices = twiss.rows.indices[names]
-    tw_entry = twiss.rows[coll_entry_indices]
-    tw_exit = twiss.rows[coll_entry_indices+1]
-    tw_exit.name = tw_entry.name
-    return tw_entry, tw_exit
-
+    warnings.warn("The function xcoll.get_optics_at() is deprecated and will be "
+                + "removed in the future. Please use line.scattering.get_optics_at() instead.", DeprecationWarning)
+    return line.collimators.get_optics_at(names=names, twiss=twiss)
 
 def open_collimators(line, names=None):
-    if names is None:
-        names = line.get_elements_of_type(_all_collimator_classes)[1]
-    if len(names) == 0:
-        print("No collimators found in line.")
-    else:
-        for coll in names:
-            line[coll].open_jaws(keep_tilts=False)
-            line[coll].gap = None
+    warnings.warn("The function xcoll.open_collimators() is deprecated and will be "
+                + "removed in the future. Please use line.scattering.open_collimators() instead.", DeprecationWarning)
+    line.collimators.open(names=names)
 
 def send_to_parking(line, names=None):
-    if names is None:
-        names = line.get_elements_of_type(_all_collimator_classes)[1]
-    if len(names) == 0:
-        print("No collimators found in line.")
-    else:
-        raise NotImplementedError("Need to move this to new type manager or so.")
-
+    warnings.warn("The function xcoll.send_to_parking() is deprecated and will be "
+                + "removed in the future. Please use line.scattering.send_to_parking() instead.", DeprecationWarning)
+    line.collimators.to_parking(names=names)
 
 def enable_scattering(line):
-    elements = line.get_elements_of_type(element_classes)[0]
-    if len(elements) == 0:
-        print("No xcoll elements found in line.")
-    else:
-        nemitt_x = None
-        nemitt_y = None
-        for el in elements:
-            if hasattr(el, 'optics') and el.optics is not None:
-                if nemitt_x is None:
-                    nemitt_x = el.nemitt_x
-                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):
-                    raise ValueError("Not all collimators have the same "
-                                   + "emittance. This is not supported.")
-            if hasattr(el, 'enable_scattering'):
-                el.enable_scattering()
+    warnings.warn("The function xcoll.enable_scattering() is deprecated and will be "
+                + "removed in the future. Please use line.scattering.enable() instead.", DeprecationWarning)
+    line.scattering.enable()
 
 def disable_scattering(line):
-    elements = line.get_elements_of_type(element_classes)[0]
-    if len(elements) == 0:
-        print("No xcoll elements found in line.")
-    else:
-        for el in elements:
-            if hasattr(el, 'disable_scattering'):
-                el.disable_scattering()
+    warnings.warn("The function xcoll.disable_scattering() is deprecated and will be "
+                + "removed in the future. Please use line.scattering.disable() instead.", DeprecationWarning)
+    line.scattering.disable()

{xcoll-0.5.4.dist-info → xcoll-0.5.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xcoll
-Version: 0.5.4
+Version: 0.5.5
 Summary: Xsuite collimation package
 Home-page: https://github.com/xsuite/xcoll
 License: Apache 2.0

{xcoll-0.5.4.dist-info → xcoll-0.5.5.dist-info}/RECORD

@@ -16,7 +16,7 @@ xcoll/beam_elements/elements_src/everest_crystal.h,sha256=w1wHWhrvodvcJ2Atr8LSaV
 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=IyWozG_37gRf7LGYDz4LMB2HzjexMOapFgIqzeym31w,31027
-xcoll/general.py,sha256=Q-plrkrApBD3PIKVMmo1mLTY16WxTMrijDLJgHjtDNc,534
+xcoll/general.py,sha256=7KCioNHNLS4wm9VU9iPFm0N2E6MlhkKCLpPULrQagAg,534
 xcoll/headers/checks.h,sha256=qdXsOTBOK1MwW6bdFF93j4yE648mcDtEv5rGN1w9sfk,1582
 xcoll/headers/particle_states.h,sha256=DZa_ZSaJrjnA8aHFriZKfRCkArQ8nK1t445MRwevDtA,840
 xcoll/initial_distribution.py,sha256=0O4hmO69CuTFDD6QA5G7iEMNx47vaMHn0A9IPw1dYi0,8799
@@ -25,7 +25,7 @@ xcoll/interaction_record/__init__.py,sha256=UFoLiKa-z2oX7YoszP-7Vgdt1nM6kT382v1C
 xcoll/interaction_record/interaction_record.py,sha256=G2sFXgfmkgpDMaHWJaC80aAreHbY2rGhbkhaMhWKQBg,13192
 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=j74DFJm4zD5pcYctEz4KeF9LAJ3dKXMafdNve_Gf3Rc,3348
+xcoll/line_tools.py,sha256=1yrw9b3j-yO3uyRpnKhlU0iHxDNeTj5M1jj9v3GqBj0,5634
 xcoll/lossmap.py,sha256=pV6uf-CKt6PROK_EZ2_DieJftRI2NcsE3CLG23Fth-I,8087
 xcoll/rf_sweep.py,sha256=P2X1S9pGi4OpNYnzYfQVyblFt2p8aw9EWHsKDkAuYt0,8936
 xcoll/scattering_routines/everest/__init__.py,sha256=7lkkeZ1liBjXVHCuRpgzZI6ohzHVMj5uJBO792147XY,286
@@ -407,8 +407,8 @@ 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/scattering_routines/geometry/temp.c,sha256=uak0prUg6e441GuR8A9fvAUSfg-E_jaAfGw9fu2Ogms,32437
-xcoll-0.5.4.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-xcoll-0.5.4.dist-info/METADATA,sha256=t429keDIvX-dlJNohluxRuvEASLS9LbuiXtUYJaz_N4,2709
-xcoll-0.5.4.dist-info/NOTICE,sha256=6DO_E7WCdRKc42vUoVVBPGttvQi4mRt9fAcxj9u8zy8,74
-xcoll-0.5.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-xcoll-0.5.4.dist-info/RECORD,,
+xcoll-0.5.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+xcoll-0.5.5.dist-info/METADATA,sha256=uN-Ple230sy6CY2egyegJCG9mSGd3nO3C5aWDMWU42M,2709
+xcoll-0.5.5.dist-info/NOTICE,sha256=6DO_E7WCdRKc42vUoVVBPGttvQi4mRt9fAcxj9u8zy8,74
+xcoll-0.5.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+xcoll-0.5.5.dist-info/RECORD,,