xsuite 0.43.1__cp311-cp311-macosx_11_0_arm64.whl

xsuite/__init__.py

@@ -0,0 +1,9 @@
+# copyright ################################# #
+# This file is part of the Xsuite Package.    #
+# Copyright (c) CERN, 2024.                   #
+# ########################################### #
+
+from importlib.metadata import version
+__version__ = version(__name__)
+
+from .prebuild_kernels import get_suitable_kernel, XSK_PREBUILT_KERNELS_LOCATION

xsuite/cli.py

@@ -0,0 +1,77 @@
+# copyright ############################### #
+# This file is part of the Xsuite project.  #
+# Copyright (c) CERN, 2024.                 #
+# ######################################### #
+import argparse
+from importlib.metadata import version
+
+from xsuite.prebuild_kernels import (
+    clear_kernels, regenerate_kernels, XSK_PREBUILT_KERNELS_LOCATION,
+)
+
+
+def regenerate_command(args):
+    n_threads = None if args.threads == 0 else args.threads
+    regenerate_kernels(n_threads=n_threads)
+
+
+def clean_command(args):
+    clear_kernels(verbose=args.verbose)
+    print('Cleaned kernels.')
+
+
+def info_command(args):
+    version_str = version("xsuite")
+    print(f'Xsuite version {version_str}')
+    print(f'Kernels location: {XSK_PREBUILT_KERNELS_LOCATION}')
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='xsuite-prebuild',
+        description='Regenerate and clean precompiled kernels for Xsuite.',
+    )
+    subparsers = parser.add_subparsers(
+        title='commands',
+        required=True,
+        dest='command',
+    )
+
+    # `regenerate` commend
+    regenerate_parser = subparsers.add_parser(
+        'regenerate',
+        aliases=['r'],
+        description='Regenerate the kernels.'
+    )
+    regenerate_parser.add_argument(
+        '-n', '--threads',
+        type=int,
+        help='specify the number of threads for kernel generation '
+             '(default or zero: let multiprocessing decide)',
+    )
+    regenerate_parser.set_defaults(func=regenerate_command)
+
+    # `clean` command
+    clean_parser = subparsers.add_parser(
+        'clean',
+        aliases=['c'],
+        description='Clean the kernel directory.'
+    )
+    clean_parser.add_argument(
+        '-v', '--verbose',
+        help='list the files being deleted',
+        action='store_true',
+    )
+    clean_parser.set_defaults(func=clean_command)
+
+    # `info` command
+    info_parser = subparsers.add_parser(
+        'info',
+        aliases=['i'],
+        description='Print additional info.',
+    )
+    info_parser.set_defaults(func=info_command)
+
+    # handle the right action
+    args = parser.parse_args()
+    args.func(args)

xsuite/kernel_definitions.py

@@ -0,0 +1,43 @@
+# copyright ############################### #
+# This file is part of the Xsuite project.  #
+# Copyright (c) CERN, 2025.                 #
+# ######################################### #
+import logging
+
+from xtrack.prebuilt_kernel_definitions import (ONLY_XTRACK_ELEMENTS,
+                                    NO_SYNRAD_ELEMENTS, NON_TRACKING_ELEMENTS)
+from xcoll.prebuilt_kernel_definitions import DEFAULT_XCOLL_ELEMENTS, EXTRA_XCOLL_ELEMENTS
+from xfields.prebuilt_kernel_definitions import DEFAULT_XFIELDS_ELEMENTS
+
+
+LOGGER = logging.getLogger(__name__)
+
+BASE_CONFIG = {
+    'XTRACK_MULTIPOLE_NO_SYNRAD': True,
+    'XFIELDS_BB3D_NO_BEAMSTR': True,
+    'XFIELDS_BB3D_NO_BHABHA': True,
+    'XTRACK_GLOBAL_XY_LIMIT': 1.0,
+}
+
+# These are enumerated in order specified below: the highest priority at the top
+kernel_definitions = [
+    ('non_tracking_kernels', {
+        'config': {},
+        'classes': [],
+        'extra_classes': NON_TRACKING_ELEMENTS
+    }),
+    ('default_no_config', {
+        'config': {},
+        'classes': ONLY_XTRACK_ELEMENTS + NO_SYNRAD_ELEMENTS + DEFAULT_XFIELDS_ELEMENTS + DEFAULT_XCOLL_ELEMENTS,
+        'extra_classes': EXTRA_XCOLL_ELEMENTS,
+    }),
+    ('default_base_config', {
+        'config': BASE_CONFIG,
+        'classes': ONLY_XTRACK_ELEMENTS + NO_SYNRAD_ELEMENTS + DEFAULT_XFIELDS_ELEMENTS + DEFAULT_XCOLL_ELEMENTS,
+        'extra_classes': EXTRA_XCOLL_ELEMENTS,
+    }),
+    ('only_xtrack_with_synrad', {
+        'config': {**BASE_CONFIG, 'XTRACK_MULTIPOLE_NO_SYNRAD': False},
+        'classes': ONLY_XTRACK_ELEMENTS,
+    }),
+]