Merge pull request #1 from szymonlopaciuk/update-for-slicing-and-notes

Update for slicing and add some notes

Author: szymonlopaciuk

README.md

@@ -1 +1,41 @@
 # xsuite-kernels
+
+## Simple installation
+
+The package can be installed with `pip install xsuite-kernels`. Since it is
+dependent on particular versions of the Xsuite packages, installing it might
+automatically update your Xsuite packages to newer versions. You can use the
+`-U` option to upgrade all packages to the latest versions.
+
+This package provides a set of precompiled kernels for the Xsuite packages, so
+that commonly used tracking scenarios can be run without the need to compile
+the kernels on the target machine. The precompiled kernels are distributed as
+binary Python wheels of the package `xsuite-kernels` on PyPI.
+
+When the package is installed on a supported machine `pip` will automatically
+download the appropriate kernel files and install them in the correct location,
+so that Xtrack can use them. If `xsuite-kernels` is not installed, Xtrack will
+fall back to the default behaviour of compiling the kernels on the fly.
+
+If the package is installed from source (e.g. by cloning the repository or
+downloading the source distribution in case of an unsupported platform), the
+kernels will be compiled automatically during the installation process
+(see `setup.py`).
+
+## Developer notes
+
+In case of a source installation, the building process can be skipped by setting
+an environment variable `SKIP_KERNEL_BUILD` to `1` before running `pip install`.
+
+If your local versions of `xtrack`, `xfields`, etc. have diverged from the
+versions specified in `pyproject.toml`, you can install the package with the
+`--no-deps` option to avoid upgrading the dependencies.
+
+The package exposes a `xsuite-kernels` command that can be used to manage the
+kernels on demand (add `--help` option for more information):
+
+```bash
+$ xsuite-kernels regenerate  # Regenerate all kernels
+$ xsuite-kernels clean       # Remove all kernels
+$ xsuite-kernels info        # Print some useful debug information
+```

pyproject.toml

@@ -2,10 +2,10 @@
 requires = [
     "setuptools>=64",
     "setuptools-scm[toml]>=8",
-    "xtrack==0.56.1",
-    "xfields==0.15.0",
+    "xtrack==0.57.0",
+    "xfields==0.15.1",
     "xcoll==0.3.5",
-    "xobjects==0.3.1",
+    "xobjects==0.4.0",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -19,10 +19,10 @@ readme = "README.md"
 requires-python = ">=3.8"
 license = {file = "LICENSE"}
 dependencies = [
-    "xtrack==0.56.1",
-    "xfields==0.15.0",
+    "xtrack==0.57.0",
+    "xfields==0.15.1",
     "xcoll==0.3.5",
-    "xobjects==0.3.1",
+    "xobjects==0.4.0",
 ]
 dynamic = ["version"]
 

update_versions.sh

@@ -0,0 +1,24 @@
+#! /bin/bash
+# copyright ############################### #
+# This file is part of the Xsuite project.  #
+# Copyright (c) CERN, 2024.                 #
+# ######################################### #
+
+set -e
+
+get_latest_version () {
+  pip index versions "$1" \
+  | grep 'LATEST' \
+  | sed -E -e 's/[ ]*LATEST:[ ]*([0-9.]+)/\1/g'
+}
+
+update_version () {
+  local package=$1
+  local version=$2
+  sed -i '' -E -e "s/$package==[0-9.]+/$package==$version/g" "pyproject.toml"
+}
+
+for package in xtrack xfields xcoll xobjects; do
+  latest_version=$(get_latest_version $package)
+  update_version $package $latest_version
+done

xsuite_kernels/kernel_definitions.py

@@ -49,6 +49,22 @@
     LineSegmentMap,
     FirstOrderTaylorMap,
     NonLinearLens,
+    # Slices
+    DriftSlice,
+    DriftSliceBend,
+    DriftSliceOctupole,
+    DriftSliceQuadrupole,
+    DriftSliceSextupole,
+    ThickSliceBend,
+    ThickSliceOctupole,
+    ThickSliceQuadrupole,
+    ThickSliceSextupole,
+    ThinSliceBend,
+    ThinSliceBendEntry,
+    ThinSliceBendExit,
+    ThinSliceOctupole,
+    ThinSliceQuadrupole,
+    ThinSliceSextupole,
     # Transformations
     XYShift,
     ZetaShift,

xsuite_kernels/prebuild_kernels.py

@@ -302,7 +302,7 @@ def regenerate_kernels(kernels=None, location=XSK_PREBUILT_KERNELS_LOCATION):
             elements.append(element)
 
         line = xt.Line(elements=elements)
-        tracker = xt.Tracker(line=line, compile=False)
+        tracker = xt.Tracker(line=line, compile=False, _prebuilding_kernels=True)
         tracker.config.clear()
         tracker.config.update(config)