syned 1.0.46__tar.gz → 1.0.47__tar.gz

{syned-1.0.46/syned.egg-info → syned-1.0.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: syned
-Version: 1.0.46
+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

{syned-1.0.46 → syned-1.0.47}/setup.py

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

syned-1.0.47/syned/beamline/optical_elements/multilayers/__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.47/syned/beamline/optical_elements/multilayers/multilayer.py

@@ -0,0 +1,47 @@
+# TODO: move this to syned
+
+from syned.beamline.shape import SurfaceShape
+from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
+
+class Multilayer(OpticalElementsWithSurfaceShape):
+    """
+    Constructor.
+
+    Parameters
+    ----------
+    name : str
+        The name of the optical element.
+    surface_shape : instance of SurfaceShape, optional
+        The geometry of the crystal surface. if None, it is initialized to SurfaceShape().
+    boundary_shape : instance of BoundaryShape, optional
+        The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
+    structure : str, optional
+        The multilayer structure e.g. [B,W]x50+Si.
+    period : float, optional
+        The period of the repeated bilayer in A.
+    Gamma : float, optional
+        The gamma factor.
+    """
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(),
+                 boundary_shape=None,
+                 structure='[B/W]x50+Si',
+                 period=25.0,
+                 Gamma=0.5,
+                 ):
+
+        super().__init__(name, surface_shape, boundary_shape)
+        self._structure = structure
+        self._period = period
+        self._Gamma = Gamma
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("name",                "Name" ,                                          "" ),
+                    ("surface_shape",       "Surface shape",                                  "" ),
+                    ("boundary_shape",      "Boundary shape",                                 "" ),
+                    ("structure",           "structure ([Odd,Even]xN+Substrate)",             "" ),
+                    ("period",              "period of the repeated structure",               "A"),
+                    ("Gamma",               "Gamma factor [thickness ratio Even)/(Odd+Even)", ""),
+            ] )
+

{syned-1.0.46 → syned-1.0.47/syned.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: syned
-Version: 1.0.46
+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

{syned-1.0.46 → syned-1.0.47}/syned.egg-info/SOURCES.txt

@@ -37,6 +37,8 @@ syned/beamline/optical_elements/ideal_elements/ideal_lens.py
 syned/beamline/optical_elements/ideal_elements/screen.py
 syned/beamline/optical_elements/mirrors/__init__.py
 syned/beamline/optical_elements/mirrors/mirror.py
+syned/beamline/optical_elements/multilayers/__init__.py
+syned/beamline/optical_elements/multilayers/multilayer.py
 syned/beamline/optical_elements/refractors/__init__.py
 syned/beamline/optical_elements/refractors/crl.py
 syned/beamline/optical_elements/refractors/interface.py