syned 1.0.44__tar.gz → 1.0.45__tar.gz

{syned-1.0.44/syned.egg-info → syned-1.0.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: syned
-Version: 1.0.44
+Version: 1.0.45
 Summary: SYNED (SYNchrotron Elements Dictionary) kernel library
 Home-page: https://github.com/oasys-kit/syned
 Download-URL: https://github.com/oasys-kit/syned

{syned-1.0.44 → syned-1.0.45}/setup.py

@@ -9,7 +9,7 @@ except AttributeError:
 
 NAME = 'syned'
 
-VERSION = '1.0.44'
+VERSION = '1.0.45'
 ISRELEASED = True
 
 DESCRIPTION = 'SYNED (SYNchrotron Elements Dictionary) kernel library'

syned-1.0.45/syned/__test/__init__.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# ----------------------------------------------------------------------- #
+# Copyright (c) 2025, UChicago Argonne, LLC. All rights reserved.         #
+#                                                                         #
+# Copyright 2025. UChicago Argonne, LLC. This software was produced       #
+# under U.S. Government contract DE-AC02-06CH11357 for Argonne National   #
+# Laboratory (ANL), which is operated by UChicago Argonne, LLC for the    #
+# U.S. Department of Energy. The U.S. Government has rights to use,       #
+# reproduce, and distribute this software.  NEITHER THE GOVERNMENT NOR    #
+# UChicago Argonne, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR        #
+# ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE.  If software is     #
+# modified to produce derivative works, such modified software should     #
+# be clearly marked, so as not to confuse it with the version available   #
+# from ANL.                                                               #
+#                                                                         #
+# Additionally, redistribution and use in source and binary forms, with   #
+# or without modification, are permitted provided that the following      #
+# conditions are met:                                                     #
+#                                                                         #
+#     * Redistributions of source code must retain the above copyright    #
+#       notice, this list of conditions and the following disclaimer.     #
+#                                                                         #
+#     * Redistributions in binary form must reproduce the above copyright #
+#       notice, this list of conditions and the following disclaimer in   #
+#       the documentation and/or other materials provided with the        #
+#       distribution.                                                     #
+#                                                                         #
+#     * Neither the name of UChicago Argonne, LLC, Argonne National       #
+#       Laboratory, ANL, the U.S. Government, nor the names of its        #
+#       contributors may be used to endorse or promote products derived   #
+#       from this software without specific prior written permission.     #
+#                                                                         #
+# THIS SOFTWARE IS PROVIDED BY UChicago Argonne, LLC AND CONTRIBUTORS     #
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT       #
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS       #
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UChicago     #
+# Argonne, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,        #
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,    #
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;        #
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER        #
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT      #
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN       #
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE         #
+# POSSIBILITY OF SUCH DAMAGE.                                             #
+# ----------------------------------------------------------------------- #

syned-1.0.45/syned/__test/test.py

@@ -0,0 +1,28 @@
+import traceback
+import warnings
+warnings.simplefilter("always")
+
+from syned.storage_ring.electron_beam import ElectronBeam
+
+try:
+    a = ElectronBeam.initialize_as_pencil_beam(energy_in_GeV=6.0,
+                                               current=0.2,
+                                               energy_spread=0.00095,
+                                               moment_xx =1.0,
+                                               moment_xxp =1.0,
+                                               moment_xpxp =1.0,
+                                               moment_yy =1.0,
+                                               moment_yyp =1.0,
+                                               moment_ypyp =1.0,
+                                               dispersion_x =1.0,
+                                               dispersion_y =1.0,
+                                               dispersionp_x=1.0,
+                                               dispersionp_y=1.0)
+    a.set_twiss_horizontal  (0, 0, 0)
+    a.set_twiss_vertical    (0, 1, 1, eta_y=2.0, etap_y=3.0)
+
+    print(a.info())
+
+    print(a.get_twiss_no_dispersion_all())
+except:
+    traceback.print_exc()

{syned-1.0.44 → syned-1.0.45}/syned/storage_ring/electron_beam.py

@@ -4,9 +4,13 @@ Base class for electron beams.
 This class is intentionally shorten for simplicity.
 Usually we would need to consider also the electron distribution within the beam.
 """
-from syned.syned_object import SynedObject
 import scipy.constants as codata
 import numpy
+import warnings
+
+from syned.util import deprecated
+from syned.syned_object import SynedObject
+
 
 class ElectronBeam(SynedObject):
     def __init__(self,
@@ -136,17 +140,27 @@ class ElectronBeam(SynedObject):
     @classmethod
     def _get_twiss_from_moments(cls, moment_ss, moment_sa, moment_aa):
         emittance = cls._emittance_without_dispersion(moment_ss, moment_sa, moment_aa)
-        alpha     = -moment_sa / emittance
-        beta      = moment_ss / emittance
-        gamma     = (1 + alpha**2) / beta
+        if emittance == 0.0:
+            warnings.warn(message="All moments are 0.0 and the calculation is not possible. \u03b5 = \u03b1 = \u03b2 = \u03b3 = 0.0 is returned.",
+                          category=UserWarning, stacklevel=2)
+            return 0.0, 0.0, 0.0, 0.0
+        else:
+            alpha     = -moment_sa / emittance
+            beta      = moment_ss / emittance
+            gamma     = (1 + alpha**2) / beta
 
-        alpha = 0.0 if alpha == 0 else alpha # to avoid -0.0
+            alpha = 0.0 if alpha == 0 else alpha # to avoid -0.0
 
-        return emittance, alpha, beta, gamma
+            return emittance, alpha, beta, gamma
 
     @classmethod
     def _get_moments_from_twiss_without_dispersion(cls, emittance, alpha, beta):
-        gamma = (1 + alpha ** 2) / beta
+        if beta == 0:
+            warnings.warn(message="With \u03b2 = 0.0 the calculation of \u03b3 is not possible. \u03b3 = 0.0 is used.",
+                          category=UserWarning, stacklevel=2)
+            gamma = 0.0
+        else:
+            gamma = (1 + alpha ** 2) / beta
 
         moment_ss = beta * emittance
         moment_sa = -alpha * emittance
@@ -168,7 +182,7 @@ class ElectronBeam(SynedObject):
     # --- GETTERS
     #     # ---------------------------------------------------------------------------------------------------------------------------------------------
     #
-    def get_sigmas_horizontal(self, dispersion=False):
+    def get_sigmas_horizontal(self, dispersion=True):
         """
         Returns the sigmas in horizontal direction.
 
@@ -183,7 +197,7 @@ class ElectronBeam(SynedObject):
 
         return numpy.sqrt(moment_xx), numpy.sqrt(moment_xpxp)
 
-    def get_sigmas_vertical(self, dispersion=False):
+    def get_sigmas_vertical(self, dispersion=True):
         """
         Returns the sigmas in vertical direction.
 
@@ -197,7 +211,7 @@ class ElectronBeam(SynedObject):
 
         return numpy.sqrt(moment_yy), numpy.sqrt(moment_ypyp)
 
-    def get_sigmas_all(self, dispersion=False):
+    def get_sigmas_all(self, dispersion=True):
         """
         Returns all sigmas.
 
@@ -213,7 +227,7 @@ class ElectronBeam(SynedObject):
 
         return sigma_x, sigmap_x, sigma_y, sigmap_y
 
-    def get_moments_horizontal(self, dispersion=False):
+    def get_moments_horizontal(self, dispersion=True):
         """
         Returns the moments in the horizontal direction.
 
@@ -231,7 +245,7 @@ class ElectronBeam(SynedObject):
                                                                     self._dispersion_x,
                                                                     self._dispersionp_x)
 
-    def get_moments_vertical(self, dispersion=False):
+    def get_moments_vertical(self, dispersion=True):
         """
         Returns the moments in the vertical direction.
 
@@ -250,7 +264,7 @@ class ElectronBeam(SynedObject):
                                                                    self._dispersion_y,
                                                                    self._dispersionp_y)
 
-    def get_moments_all(self, dispersion=False):
+    def get_moments_all(self, dispersion=True):
         """
         Returns all moments.
 
@@ -542,16 +556,16 @@ class ElectronBeam(SynedObject):
         self._moment_xpxp   = moment_xpxp
 
         # RETROCOMPATIBILITY
-        eta_x = kwargs.get("eta_x", None)
-        etap_x = kwargs.get("etap_x", None)
-
-        if eta_x is not None or etap_x is not None:
-            self._send_deprectation_warning("Setting dispersion parameters with set_twiss_horizontal(..., eta_x, etap_x)",
-                                             "set_dispersion_horizontal(eta_x, etap_x) separately")
-            self.set_dispersion_vertical(0.0 if eta_x is None else eta_x,
-                                         0.0 if etap_x is None else etap_x)
+        eta_x  = kwargs.get("eta_x", 0.0)
+        etap_x = kwargs.get("etap_x", 0.0)
 
-        self.set_dispersion_horizontal(eta_x, etap_x)
+        if eta_x != 0.0 or etap_x != 0.0:
+            warnings.warn(message="Setting dispersion parameters with `set_twiss_horizontal(..., eta_x, etap_x)` is deprecated "
+                                  "and will be removed in a future version. "
+                                  "Use `set_dispersion_horizontal(eta_x, etap_x)` separately instead.",
+                          category=DeprecationWarning, stacklevel=2)
+            self.set_dispersion_horizontal(0.0 if eta_x is None else eta_x,
+                                           0.0 if etap_x is None else etap_x)
 
     def set_twiss_vertical(self, emittance_y, alpha_y, beta_y, **kwargs):
         """
@@ -578,12 +592,15 @@ class ElectronBeam(SynedObject):
         self._moment_ypyp   = moment_ypyp
 
         # RETROCOMPATIBILITY
-        eta_y  = kwargs.get("eta_y", None)
-        etap_y = kwargs.get("etap_y", None)
+        eta_y  = kwargs.get("eta_y", 0.0)
+        etap_y = kwargs.get("etap_y", 0.0)
+
+        if eta_y != 0.0 or etap_y != 0.0:
+            warnings.warn(message="Setting dispersion parameters with `set_twiss_vertical(..., eta_y, etap_y)` is deprecated "
+                                  "and will be removed in a future version. "
+                                  "Use `set_dispersion_vertical(eta_y, etap_y)` separately instead.",
+                          category=DeprecationWarning, stacklevel=2)
 
-        if eta_y is not None or etap_y is not None:
-            self._send_deprectation_warning("Setting dispersion parameters with set_twiss_vertical(..., eta_y, etap_y)",
-                                             "set_dispersion_vertical(eta_y, etap_y) separately")
             self.set_dispersion_vertical(0.0 if eta_y is None else eta_y,
                                          0.0 if etap_y is None else etap_y)
 
@@ -646,7 +663,7 @@ class ElectronBeam(SynedObject):
         """
         return numpy.sqrt(1.0 - 1.0 / self.lorentz_factor() ** 2)
 
-    def emittance(self, dispersion=False):
+    def emittance(self, dispersion=True):
         if not dispersion:
             emittance_x = self._emittance_without_dispersion(self._moment_xx, self._moment_xxp, self._moment_xpxp)
             emittance_y = self._emittance_without_dispersion(self._moment_yy, self._moment_yyp, self._moment_ypyp)
@@ -668,17 +685,14 @@ class ElectronBeam(SynedObject):
     #
     # backcompatibility (deprecated)
     #
-    def get_twiss_no_dispersion_all(self):
-        self._send_deprectation_warning("get_twiss_no_dispersion_all()", "get_twiss_all(dispersion=False)")
-        return self.get_twiss_all()
+    @deprecated("Use `get_twiss_all()` instead")
+    def get_twiss_no_dispersion_all(self): return self.get_twiss_all()
 
-    def get_twiss_no_dispersion_horizontal(self):
-        self._send_deprectation_warning("get_twiss_no_dispersion_horizontal()", "get_twiss_horizontal(dispersion=False)")
-        return self.get_twiss_horizontal()
+    @deprecated("Use `get_twiss_horizontal()` instead")
+    def get_twiss_no_dispersion_horizontal(self): return self.get_twiss_horizontal()
 
-    def get_twiss_no_dispersion_vertical(self):
-        self._send_deprectation_warning("get_twiss_no_dispersion_vertical()", "get_twiss_vertical(dispersion=False)")
-        return self.get_twiss_vertical()
+    @deprecated("Use `get_twiss_vertical()` instead")
+    def get_twiss_no_dispersion_vertical(self): return self.get_twiss_vertical()
 
 
 if __name__ == "__main__":
@@ -779,10 +793,10 @@ if __name__ == "__main__":
         # yyp = 1.0488e-14
         # ypyp = 3.7609e-12
         print("moments (with dispersion): ", a.get_moments_all(dispersion=True))
-        print("moments (without dispersion): ", a.get_moments_all(dispersion=False))
+        print("moments (without dispersion): ", a.get_moments_all(dispersion=True))
         # sigma x = 3.1199e-05
         # sigma x' = 4.5183e-06
         # sigma y = 5.1565e-06
         # sigma y' = 1.9393e-06
         print("sigmas (with dispersion): ", a.get_sigmas_all(dispersion=True))
-        print("sigmas (without dispersion): ", a.get_sigmas_all(dispersion=False))
+        print("sigmas (without dispersion): ", a.get_sigmas_all(dispersion=True))

{syned-1.0.44 → syned-1.0.45}/syned/syned_object.py

@@ -1,5 +1,4 @@
 import copy
-import warnings
 from collections import OrderedDict
 try:
     import json_tricks as json # to save numpy arrays
@@ -263,12 +262,3 @@ class SynedObject(object):
 
         """
         return copy.deepcopy(self)
-
-    @classmethod
-    def _send_deprectation_warning(cls, function_name_use, new_function_use):
-        warnings.warn(
-            f"{function_name_use} is deprecated and will be removed in a future version. "
-            f"Use {new_function_use} instead.",
-            DeprecationWarning,
-            stacklevel=2
-        )

syned-1.0.45/syned/util/__init__.py

@@ -0,0 +1,22 @@
+import functools
+import warnings
+
+def deprecated(reason: str = ""):
+    """
+    Decorator to mark functions as deprecated.
+    It will result in a warning being emitted when the function is used.
+    """
+    def decorator(func):
+        msg = f"The function `{func.__name__}` is deprecated."
+        if reason:
+            msg += f" {reason}"
+
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            warnings.simplefilter("always", DeprecationWarning)  # show even if filtered
+            warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
+            warnings.simplefilter("default", DeprecationWarning)  # reset filter
+            return func(*args, **kwargs)
+        return wrapper
+
+    return decorator

{syned-1.0.44 → syned-1.0.45/syned.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: syned
-Version: 1.0.44
+Version: 1.0.45
 Summary: SYNED (SYNchrotron Elements Dictionary) kernel library
 Home-page: https://github.com/oasys-kit/syned
 Download-URL: https://github.com/oasys-kit/syned

{syned-1.0.44 → syned-1.0.45}/syned.egg-info/SOURCES.txt

@@ -10,6 +10,8 @@ syned.egg-info/dependency_links.txt
 syned.egg-info/not-zip-safe
 syned.egg-info/requires.txt
 syned.egg-info/top_level.txt
+syned/__test/__init__.py
+syned/__test/test.py
 syned/beamline/__init__.py
 syned/beamline/beamline.py
 syned/beamline/beamline_element.py