sad2xs 0.0.1__tar.gz

sad2xs-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sad2xs-0.0.1/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: sad2xs
+Version: 0.0.1
+Summary: Conversion of SAD lattices to Xtrack format
+Home-page: https://github.com/JPTS2/SAD2XS
+Author: J. Salvesen, G. Iadarola
+Author-email: john.salvesen@cern.ch
+License: Apache 2.0
+Project-URL: Bug Tracker, https://github.com/JPTS2/SAD2XS/issues
+Project-URL: Documentation, https://github.com/JPTS2/SAD2XS/blob/main/README.md
+Project-URL: Source Code, https://github.com/JPTS2/SAD2XS
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.0
+Requires-Dist: xtrack>=0.73
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
+
+# SAD2XS
+
+## The (Unofficial) Strategic Accelerator Design (SAD) to Xsuite Converter
+SAD2XS is a lattice conversion tool, taking a lattice path to a .sad lattice 
+file and outputing an Xtrack Line object.
+
+## Project status
+This project is a **work in progress**.
+Tests have been sucessfully performed against FCC-ee.
+Tests against SuperKEKB have known issues due to the physics model differences between SAD and Xsuite.
+
+## Authors and acknowledgment
+Written by John Salvesen and Giovanni Iadarola
+
+With thanks to Katsunobu Oide for their discussion and expertise on SAD
+
+With thanks to Ghislain Roy for his support in testing
+
+## License
+Apache License Version 2.0
+
+## Support
+Please contact john.salvesen@cern.ch with queries
+
+## Known Issues
+
+### Solenoid Import
+No import of solenoid slices. Currently these slices are ignored.
+Only the DZ geometric correction at the BOUND edge of the solenoid is imported.
+No import of the other corrections (DX, DY, CHI1, CHI2, CHI3)
+
+### Fringe Import
+No import of maxwellian fringes features in SAD.
+Not currently available in Xsuite

sad2xs-0.0.1/README.md

@@ -0,0 +1,34 @@
+# SAD2XS
+
+## The (Unofficial) Strategic Accelerator Design (SAD) to Xsuite Converter
+SAD2XS is a lattice conversion tool, taking a lattice path to a .sad lattice 
+file and outputing an Xtrack Line object.
+
+## Project status
+This project is a **work in progress**.
+Tests have been sucessfully performed against FCC-ee.
+Tests against SuperKEKB have known issues due to the physics model differences between SAD and Xsuite.
+
+## Authors and acknowledgment
+Written by John Salvesen and Giovanni Iadarola
+
+With thanks to Katsunobu Oide for their discussion and expertise on SAD
+
+With thanks to Ghislain Roy for his support in testing
+
+## License
+Apache License Version 2.0
+
+## Support
+Please contact john.salvesen@cern.ch with queries
+
+## Known Issues
+
+### Solenoid Import
+No import of solenoid slices. Currently these slices are ignored.
+Only the DZ geometric correction at the BOUND edge of the solenoid is imported.
+No import of the other corrections (DX, DY, CHI1, CHI2, CHI3)
+
+### Fringe Import
+No import of maxwellian fringes features in SAD.
+Not currently available in Xsuite

sad2xs-0.0.1/sad2xs/__init__.py

@@ -0,0 +1,2 @@
+from .main import sad2xsuite
+from .expressions import generate_expressions

sad2xs-0.0.1/sad2xs/expressions.py

@@ -0,0 +1,158 @@
+"""
+Creation of expresions for imported lattice
+"""
+################################################################################
+# Required Packages
+################################################################################
+import numpy as np
+
+################################################################################
+# Helper Functions
+################################################################################
+def get_element_class(element_name):
+    """
+    Get the element class from the element name. Used to define powering groups.
+
+    e.g. 'Bend.1' -> 'Bend'
+
+    Parameters:
+    ----------
+    element_name: str
+        The name of the element
+        
+    Outputs
+    ----------
+    element_class: string
+        The name of the element class
+    """
+    # Default to the element name
+    element_class   = element_name
+    # Split the element name by the last period
+    substrings      = element_name.rsplit('.', 1)
+    # If the element name has a period, the base string is the first substring
+    if len(substrings) == 2 and substrings[1].isdigit():
+        element_class   = substrings[0]
+
+    return element_class
+
+################################################################################
+# Conversion Function
+################################################################################
+
+def generate_expressions(line):
+    """
+    Generate Xsuite line variables for an Xtrack lattice 
+    according to the naming of the elements
+
+    Parameters:
+    ----------
+    line: xtrack.Line
+        Xsuite Line object representing the lattice    
+
+    Outputs
+    ----------
+    line: xtrack.Line
+        Xsuite Line object representing the lattice
+    """
+
+    ############################################################################
+    # Build Line Table
+    ############################################################################
+    line.build_tracker()
+    line_table  = line.get_table(attr = True)
+    line.discard_tracker()
+
+    ############################################################################
+    # Bend Knobs
+    ############################################################################
+    bend_names  = line_table.rows[line_table['element_type'] == 'Bend'].name
+
+    for bend_name in bend_names:
+        # Get the root name ignoring any numbering
+        bend_class = get_element_class(bend_name)
+
+        # If the bend has a k0, create a variable
+        if line[bend_name].k0 != 0:
+            line.vars[f'k0_{bend_class}']       = line[bend_name].k0
+            # Assign the variable to the bend
+            line.element_refs[bend_name].k0     = line.vars[f'k0_{bend_class}']
+
+        # If the bend has a h value, and it's close to k0
+        # Assign to the same variable
+        if line[bend_name].h != 0:
+            if np.isclose(line[bend_name].h, line[bend_name].k0, rtol=1E-3):
+                line.element_refs[bend_name].h  = line.vars[f'k0_{bend_class}']
+
+        # No such thing as k0s in xtrack, it is controlled by s_rotation
+
+        # If the bend has a k1, create a variable
+        if line[bend_name].k1 != 0:
+            line.vars[f'k1_{bend_class}']       = line[bend_name].k1
+            # Assign the variable to the bend
+            line.element_refs[bend_name].k1     = line.vars[f'k1_{bend_class}']
+
+    ############################################################################
+    # Quadrupole Knobs
+    ############################################################################
+    quad_names  = line_table.rows[line_table['element_type'] == 'Quadrupole'].name
+
+    for quad_name in quad_names:
+        # Get the root name ignoring any numbering
+        quad_class = get_element_class(quad_name)
+
+        # If the quad has a k1, create a variable
+        if line[quad_name].k1 != 0:
+            line.vars[f'k1_{quad_class}']       = line[quad_name].k1
+            # Assign the variable to the bend
+            line.element_refs[quad_name].k1     = line.vars[f'k1_{quad_class}']
+
+        # If the quad has a k1s, create a variable
+        if line[quad_name].k1s != 0:
+            line.vars[f'k1s_{quad_class}']      = line[quad_name].k1s
+            # Assign the variable to the bend
+            line.element_refs[quad_name].k1s    = line.vars[f'k1s_{quad_class}']
+
+    ############################################################################
+    # Sextupole Knobs
+    ############################################################################
+    sext_names  = line_table.rows[line_table['element_type'] == 'Sextupole'].name
+
+    for sext_name in sext_names:
+        # Get the root name ignoring any numbering
+        sext_class = get_element_class(sext_name)
+
+        # If the quad has a k1, create a variable
+        if line[sext_name].k2 != 0:
+            line.vars[f'k2_{sext_class}']       = line[sext_name].k2
+            # Assign the variable to the bend
+            line.element_refs[sext_name].k2     = line.vars[f'k2_{sext_class}']
+
+        # If the quad has a k2s, create a variable
+        if line[sext_name].k2s != 0:
+            line.vars[f'k2s_{sext_class}']      = line[sext_name].k2s
+            # Assign the variable to the bend
+            line.element_refs[sext_name].k2s    = line.vars[f'k2s_{sext_class}']
+
+    ############################################################################
+    # RF Cavities
+    ############################################################################
+    cavi_names  = line_table.rows[line_table['element_type'] == 'Cavity'].name
+
+    for cavi_name in cavi_names:
+        # Get the root name ignoring any numbering
+        cavi_class = get_element_class(cavi_name)
+
+        # Create cavity variables
+        line.vars[f'volt_{cavi_class}']    = line[cavi_name].voltage
+        line.vars[f'freq_{cavi_class}']    = line[cavi_name].frequency
+        line.vars[f'lag_{cavi_class}']     = line[cavi_name].lag
+
+        # Assign the variables to the cavity
+        line.element_refs[cavi_name].voltage   = line.vars[f'volt_{cavi_class}']
+        line.element_refs[cavi_name].frequency = line.vars[f'freq_{cavi_class}']
+        line.element_refs[cavi_name].lag       = line.vars[f'lag_{cavi_class}']
+
+    ############################################################################
+    # Return Line
+    ############################################################################
+    return line