syned 1.0.47__py3-none-any.whl

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/util/json_tools.py

@@ -0,0 +1,198 @@
+"""
+Functions to read/write syned objects in json files.
+
+Notes
+-----
+The elements that are not explicitely imported in the code that follows, but they MUST be imported
+to define the objects at run time.
+To import more elements, yoy can use the exec_command keyword.
+
+"""
+from syned.storage_ring.electron_beam import ElectronBeam
+from syned.storage_ring.magnetic_structures.undulator import Undulator
+from syned.storage_ring.magnetic_structures.wiggler import Wiggler
+from syned.storage_ring.magnetic_structures.bending_magnet import BendingMagnet
+from syned.storage_ring.magnetic_structure import MagneticStructure
+from syned.beamline.optical_elements.ideal_elements.screen import Screen
+from syned.beamline.optical_elements.ideal_elements.ideal_lens import IdealLens
+from syned.beamline.optical_elements.absorbers.filter import Filter
+from syned.beamline.optical_elements.absorbers.slit import Slit
+from syned.beamline.optical_elements.absorbers.beam_stopper import BeamStopper
+from syned.beamline.optical_elements.absorbers.holed_filter import HoledFilter
+from syned.beamline.optical_elements.mirrors.mirror import Mirror
+from syned.beamline.optical_elements.crystals.crystal import Crystal
+from syned.beamline.optical_elements.gratings.grating import Grating
+from syned.beamline.optical_elements.gratings.grating import GratingVLS
+from syned.beamline.optical_elements.gratings.grating import GratingBlaze
+from syned.beamline.optical_elements.gratings.grating import GratingLamellar
+
+from syned.beamline.shape import BoundaryShape
+from syned.beamline.shape import Rectangle, Ellipse, Circle
+from syned.beamline.shape import MultiplePatch
+from syned.beamline.shape import DoubleRectangle, DoubleEllipse, DoubleCircle
+
+from syned.beamline.shape import SurfaceShape
+from syned.beamline.shape import Conic, Plane, Sphere, SphericalCylinder
+from syned.beamline.shape import Ellipsoid, EllipticalCylinder
+from syned.beamline.shape import Paraboloid, ParabolicCylinder
+from syned.beamline.shape import Hyperboloid, HyperbolicCylinder
+from syned.beamline.shape import Toroid
+
+from syned.storage_ring.light_source import LightSource
+from syned.storage_ring.empty_light_source import EmptyLightSource
+
+from syned.beamline.beamline import Beamline
+from syned.beamline.beamline_element import BeamlineElement
+from syned.beamline.element_coordinates import ElementCoordinates
+
+from collections import OrderedDict
+
+try:
+    import json_tricks as json # to save numpy arrays
+except:
+    import json
+from urllib.request import urlopen
+
+def load_from_json_file(file_name, exec_commands=None):
+    """
+    Function to load a syned object from a json file.
+
+    Parameters
+    ----------
+    file_name : str
+        The file name.
+    exec_commands : str
+        The commands (typically import...) to be executed before accesing the file.
+
+    Returns
+    -------
+    instance of SynedObject
+
+    """
+    f = open(file_name)
+    text = f.read()
+    f.close()
+    return load_from_json_text(text, exec_commands=exec_commands)
+
+def load_from_json_url(file_url, exec_commands=None):
+    """
+    Function to load a syned object from a remote json file.
+
+    Parameters
+    ----------
+    file_url : str
+        The URL with the file name.
+    exec_commands : str
+        The commands (typically import...) to be executed before accesing the file.
+
+    Returns
+    -------
+    instance of SynedObject
+
+    """
+    u = urlopen(file_url)
+    ur = u.read()
+    url = ur.decode(encoding='UTF-8')
+    return load_from_json_text(url, exec_commands=exec_commands)
+
+def load_from_json_text(text, exec_commands=None):
+    """
+    Function to load a syned object from a json txt.
+
+    Parameters
+    ----------
+    text : str
+        The text with the corresponding info.
+    exec_commands : str
+        The commands (typically import...) to be executed before accesing the file.
+
+    Returns
+    -------
+    instance of SynedObject
+
+    """
+    return load_from_json_dictionary_recurrent(json.loads(text), exec_commands=exec_commands)
+
+def load_from_json_dictionary_recurrent(jsn, verbose=False, exec_commands=None):
+    """
+    Function to convert a dictionary (got from json file) into a syned object.
+
+    Parameters
+    ----------
+    jsn : dict
+        The dictionary with json file information.
+    verbose : boolean, optional
+        Define or not verbose output.
+    exec_commands : str
+        The commands (typically import...) to be executed before accesing the file.
+
+    Returns
+    -------
+    instance of SynedObject
+
+    """
+    if isinstance(exec_commands, list):
+        for command in exec_commands:
+            if verbose: print(">>>>",command)
+            exec(command)
+    elif isinstance(exec_commands, str):
+        if verbose: print(">>>>", exec_commands)
+        exec(exec_commands)
+
+    if verbose: print(jsn.keys())
+    if "CLASS_NAME" in jsn.keys():
+        if verbose: print("FOUND CLASS NAME: ",jsn["CLASS_NAME"])
+        if verbose: print(">>>>eval: ", jsn["CLASS_NAME"])
+        try:
+            tmp1 = eval(jsn["CLASS_NAME"]+"()")
+        except:
+            raise RuntimeError("Error evaluating: "+jsn["CLASS_NAME"]+"() ** you could use the exec_command keyword to import it at run time **")
+
+
+        if tmp1.keys() is not None:
+            NOT_FOUND = "--------NOT-FOUND--------"
+            for key in tmp1.keys():
+                stored_value = jsn.get(key, NOT_FOUND)
+                if str(stored_value) != NOT_FOUND:
+                    if verbose: print(">>>>processing",key ,type(jsn[key]))
+                    if isinstance(jsn[key],dict):
+                        if verbose: print(">>>>>>>>dictionary found, starting recurrency",key ,type(jsn[key]))
+                        tmp2 = load_from_json_dictionary_recurrent(jsn[key],exec_commands=exec_commands)
+                        if verbose: print(">>>>2",key,type(tmp2))
+                        tmp1.set_value_from_key_name(key,tmp2)
+                    elif isinstance(jsn[key], list):
+                        if verbose: print(">>>>>>>>LIST found, starting recurrency",key ,type(jsn[key]))
+                        out_list_of_objects = []
+                        for element in jsn[key]:
+                            if isinstance(element, dict):
+                                if verbose: print(">>>>>>>>LIST found, starting recurrency",key ,type(element))
+                                tmp3 = load_from_json_dictionary_recurrent(element, exec_commands=exec_commands)
+                                if verbose: print(">>>>3",type(tmp3))
+                                out_list_of_objects.append(tmp3)
+                            else:
+                                print("***** Failed to load", element)
+                        if verbose: print("kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk",out_list_of_objects)
+                        tmp1.set_value_from_key_name(key,out_list_of_objects)
+                            # tmp1.set_value_from_key_name(key,tmp2)
+                    else:
+                        if verbose: print(">>>>>>> setting value for key: ",key," to: ",repr(jsn[key]))
+                        tmp1.set_value_from_key_name(key,jsn[key])
+
+        return tmp1
+
+
+if __name__ == "__main__":
+
+    file_url = "http://ftp.esrf.fr/pub/scisoft/syned/lightsources/ESRF_ID01_EBS_PPU35_22.json"
+    syned_obj = load_from_json_url(file_url)
+    print(syned_obj.info())
+
+
+    #
+    # file_url = "/home/manuel/Oasys/ALSU-IR-BM.json"
+    # syned_obj = load_from_json_file(file_url)
+    # print(syned_obj.info())
+
+    # file_url = "/home/manuel/Oasys/bl.json"
+    # syned_obj = load_from_json_file(file_url)
+    # print(syned_obj.info())

syned/widget/widget_decorator.py

@@ -0,0 +1,67 @@
+
+from syned.beamline.beamline import Beamline
+
+class WidgetDecorator(object):
+    """
+    Definition of a widget decorator (to be used by widget implementations).
+
+    """
+
+    @classmethod
+    def syned_input_data(cls, multi_input=False):
+        """
+        A string to help defining SYNED data in OASYS.
+
+        Returns
+        -------
+        list
+            [("SynedData", Beamline, "receive_syned_data")]
+
+        """
+        try: # OASYS2
+            import oasys2
+
+            if not multi_input:
+                from orangewidget.widget import Input
+
+                return Input(name="Syned Data",
+                             type=Beamline,
+                             id="SynedData",
+                             default=True, auto_summary=False)
+            else:
+                from orangewidget.widget import MultiInput
+
+                return MultiInput(name="Syned Data",
+                                  type=Beamline,
+                                  id="SynedData",
+                                  default=True, auto_summary=False)
+        except:
+            return [("SynedData", Beamline, "receive_syned_data")]
+
+    @classmethod
+    def append_syned_input_data(cls, inputs):
+        """
+
+        Parameters
+        ----------
+        inputs
+
+
+        """
+        for input in WidgetDecorator.syned_input_data():
+            inputs.append(input)
+
+    def receive_syned_data(self, data):
+        """
+        To be implemented in the main object.
+
+        Parameters
+        ----------
+        data
+
+        Raises
+        ------
+        NotImplementedError
+
+        """
+        raise NotImplementedError("Should be implemented")

syned-1.0.47.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: syned
+Version: 1.0.47
+Summary: SYNED (SYNchrotron Elements Dictionary) kernel library
+Home-page: https://github.com/oasys-kit/syned
+Download-URL: https://github.com/oasys-kit/syned
+Author: Manuel Sanchez del Rio, Luca Rebuffi
+Author-email: srio@esrf.eu
+Maintainer: L Rebuffi and M Sanchez del Rio
+Maintainer-email: srio@esrf.eu
+License: GPLv3
+Keywords: dictionary,glossary,synchrotronsimulation
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Plugins
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: numpy
+Requires-Dist: scipy
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-dist
+Dynamic: summary
+
+=====
+syned
+=====
+
+About
+-----
+
+SYNchrotron Elements Dictionary.
+
+A python library to define the components  (sources, mirrors, crystals, etc.) of a synchrotron beamline and their positions.
+They can be read/write to json files.
+It is used by OASYS as a common tool to define sources and optical systems that are then exported to the different add-ons.
+
+
+Documentation
+-------------
+https://syned.readthedocs.io/
+
+
+Source repository
+-----------------
+https://github.com/oasys-kit/syned
+
+Quick-installation
+------------------
+
+Syned can be installed with Python 3.x:
+
+.. code-block:: console
+
+    $ python -m pip install syned
+
+Graphical user interface
+------------------------
+
+A graphical interface is available under Oasys:  https://github.com/oasys-kit/OASYS-SYNED
+
+Reference
+---------
+
+Luca Rebuffi, Manuel Sanchez del Rio,
+"Interoperability and complementarity of simulation tools for beamline design in the
+OASYS environment,"
+Proc. SPIE 10388, Advances in Computational Methods for X-Ray Optics IV, 1038808 (23 August 2017);
+https://doi.org/10.1117/12.2274232
+

syned-1.0.47.dist-info/RECORD

@@ -0,0 +1,54 @@
+syned/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+syned/syned_object.py,sha256=p9nGtvxVZkNx5JlDol3c-1n8qXRxtFc01SjXV8HLyOs,8033
+syned/__test/__init__.py,sha256=OQwx0a5g_fzul1uaL4Lsq60GAnadpFUphcVuDbgjCKE,3390
+syned/__test/test.py,sha256=ID7--g20G8vLj9q817Z8eCIoIEI2O_KVBd01ehivOpc,1172
+syned/beamline/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/beamline/beamline.py,sha256=dOuwOj68613zobq-OisfNyccGNaHtbM1i5kwpAtRVgw,4504
+syned/beamline/beamline_element.py,sha256=48TJQH3bps7txipruFmQy7mk9uWEqqJLwinyjtGUWgc,2183
+syned/beamline/element_coordinates.py,sha256=t92vzY7--vPg5duCrSEeUVpcVTHWPXaP6lqSE99w_Zc,5276
+syned/beamline/optical_element.py,sha256=foJuYNYmPFC9FQ0i1Y_AApc3nW-S0Wid_JMP47xTqRw,1143
+syned/beamline/optical_element_with_surface_shape.py,sha256=uNbTPb2AdwvS3e5SRGdKNX8Gs4kJ0t2q9VjE7qTkOog,4267
+syned/beamline/shape.py,sha256=QAhPKxDhj-ciS6AiijFFNWgtDWfhqehqx2IerN3bRXA,87065
+syned/beamline/optical_elements/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/beamline/optical_elements/absorbers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+syned/beamline/optical_elements/absorbers/absorber.py,sha256=_8_ynlSVWQv5lzMusL6mYkS56XvHeeN7rd-POR6ChKQ,663
+syned/beamline/optical_elements/absorbers/beam_stopper.py,sha256=pHywuyGAP41oWc3i9MgKaF9Sqgl9-MtRiDAX8zuQoGI,1973
+syned/beamline/optical_elements/absorbers/filter.py,sha256=yEig-uycMKdtxG_11tNAlewNTbv0YIaNMusaldT6JEQ,1715
+syned/beamline/optical_elements/absorbers/holed_filter.py,sha256=y4CcIZ6D2mxTfEx9WtwW5KZNCvM5cUfcIBtbr7U2orM,2050
+syned/beamline/optical_elements/absorbers/slit.py,sha256=eJi23OgDLUdVVFhCnzrE01xuk7WORcXIGB6l_PK0cag,2597
+syned/beamline/optical_elements/crystals/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/beamline/optical_elements/crystals/crystal.py,sha256=Wrjy4ZRn6dBhI19qNOgVN8Jod4yQbU8nSbgtmZL40jw,2925
+syned/beamline/optical_elements/gratings/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/beamline/optical_elements/gratings/grating.py,sha256=sOaidmEgmOAV4R8Jch6JH0ElqoQRQm7Al7HAr_O8IYA,12011
+syned/beamline/optical_elements/ideal_elements/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/beamline/optical_elements/ideal_elements/ideal_element.py,sha256=qmOt67kOSNdAJCZWcf6KIKGNtukTl9WcbQl6PnCrPzs,600
+syned/beamline/optical_elements/ideal_elements/ideal_fzp.py,sha256=wkqxe7sviI1DYomRYxeaC5W0YYOQBFJaqe64q2BlO8M,5067
+syned/beamline/optical_elements/ideal_elements/ideal_lens.py,sha256=X2zHfPbUGOn_LWaz-A-2EpOrog7gCTJ8wu10ZoJPRvY,1654
+syned/beamline/optical_elements/ideal_elements/screen.py,sha256=NpVJZsA-u-T5OgUWxTYebHdoNJb0oKh2ENRhv8WpJ_A,408
+syned/beamline/optical_elements/mirrors/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/beamline/optical_elements/mirrors/mirror.py,sha256=RAFUzYlj09rPMPvFVlZnMTeQMogMO1aHRvCJIddiFqg,1722
+syned/beamline/optical_elements/multilayers/__init__.py,sha256=OQwx0a5g_fzul1uaL4Lsq60GAnadpFUphcVuDbgjCKE,3390
+syned/beamline/optical_elements/multilayers/multilayer.py,sha256=AweNp22N1Jfthd7-1KDBhBtlRqqmRGi1qu7Yed0f-pM,2000
+syned/beamline/optical_elements/refractors/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/beamline/optical_elements/refractors/crl.py,sha256=gew_bUP8OOwjYwxUOh73vj9wctE23RQNzXYxsZA_zg0,3029
+syned/beamline/optical_elements/refractors/interface.py,sha256=T_ZXkN3YO8fjFE9I4jN9fMHOp0qmlFotldklUW8mvCQ,2337
+syned/beamline/optical_elements/refractors/lens.py,sha256=xQUiYl3t3JwrZnNkTFDsnq5-FejaNPvCri_qlwCWSA8,3310
+syned/storage_ring/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/storage_ring/electron_beam.py,sha256=O0_tuulZcpT6_Sf4upMbbeJOVHyewxdqvs6uHlQ8JP4,28476
+syned/storage_ring/empty_light_source.py,sha256=W1YHH4HMzpMwELJ4TljL4xf0OXHcsNHgHyLYGSFMeZw,943
+syned/storage_ring/light_source.py,sha256=F-Alw_K3CxZ91N8d8KXwufDok4Z5vB6fjYvgdV4Whx0,2492
+syned/storage_ring/magnetic_structure.py,sha256=M9CsF799HEuL8oOyGyGtuFAUh1_7hXfsUoLZmtSL6t0,241
+syned/storage_ring/magnetic_structures/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+syned/storage_ring/magnetic_structures/bending_magnet.py,sha256=krg5iW1KtTmPXbx75eyHGGByBrMNssxp3jgH1JrAKRU,10493
+syned/storage_ring/magnetic_structures/insertion_device.py,sha256=XhXN7pX3L0xQly5SpEEi6_nCQ2vDcxFp_KQJZCbwpfE,4246
+syned/storage_ring/magnetic_structures/undulator.py,sha256=NkcoaRcCNJMasXUdiA_NZldLLsNynntb-12FUssxzes,13497
+syned/storage_ring/magnetic_structures/wiggler.py,sha256=2RtcKSzhLDksWLSk3D97yk_q3C-ZFr60_GJGBCzwnmQ,1053
+syned/util/__init__.py,sha256=JmVXq2RSaCjSlvdVrXYfPhCVwJhZjvFjUqBYE8oIni8,742
+syned/util/json_tools.py,sha256=vC0dQHUJnz3m1PUFK-oawHs7l-IP5WYNbVKv_gOjfNk,7615
+syned/widget/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+syned/widget/widget_decorator.py,sha256=hfjwWmK9HZe7MtwIOAHT7rUgMYN6VmHqHB2zfVVRY4E,1658
+syned-1.0.47.dist-info/licenses/LICENSE,sha256=C5iV2YY_hn_fGUPOveNdbY6tczl4oZCgfy5E8UdLQjk,1094
+syned-1.0.47.dist-info/METADATA,sha256=YZtfbepQlzDC7-uqK7UlIrLiicJV0CY-8uaD1sC1-3Q,2468
+syned-1.0.47.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+syned-1.0.47.dist-info/top_level.txt,sha256=PMrZrTESxk_mUTBz0gyGBlYvM_3BesYCHB1MUgjSlVE,6
+syned-1.0.47.dist-info/RECORD,,

syned-1.0.47.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

syned-1.0.47.dist-info/licenses/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2017-2019 The Oasys Organization
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

syned-1.0.47.dist-info/top_level.txt

@@ -0,0 +1 @@
+syned