xsuite 0.45.8__tar.gz

xsuite-0.45.8/.github/scripts/generate_summary.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+# copyright ############################### #
+# This file is part of the Xsuite project.  #
+# Copyright (c) CERN, 2024.                 #
+# ######################################### #
+set -xe
+
+echo "## Test Summary $1"
+
+results_file="reports/$1/results.txt"
+
+if [ -f "$results_file" ]; then
+  # Results file found, processing...
+  sed -i -e 's/\x1b\[[0-9;]*m//g' -e 's/^> /\\> /g' $results_file
+
+  passed=$(grep -c PASSED $results_file || true)
+  failed=$(grep "FAILED.*xsuite" $results_file | grep -P 'FAILED.* - ' | sed -E 's/.*\] (.*::[^ ]+).* - .*/\1/' | sort | uniq | wc -l)
+  skipped=$(grep -c SKIPPED $results_file || true)
+
+  echo "| Result     | Number   |"
+  echo "|------------|----------|"
+  echo "| Passed ✅  | $passed  |"
+  echo "| Failed ❌  | $failed  |"
+  echo "| Skipped ⏭️ | $skipped |"
+
+  if [ $failed -ne 0 ]; then
+    echo "### 🔴 Failed Tests"
+    grep "FAILED.*xsuite" $results_file | grep -P 'FAILED.* - ' | sed -E 's/.*\] (.*::[^ ]+).* - (.*)/\1 - \2/' | sort | uniq | while read -r failure; do
+      echo "- $failure"
+
+      echo "<details><summary>Click here to view the error details</summary><code>"
+      # Extract the failure name
+      test_name=$(echo "$failure" | sed -E 's/.*::([^\-]+).* - .*/\1/' | sed -E 's/\x1b\[[0-9;]*m//g' )
+      test_name=$(echo "$test_name" | sed 's/[][]/\\&/g')
+      # Find the start of the error block
+      error_start_line=$(grep -n "____________________ ${test_name} ____________________" $results_file | cut -d: -f1)
+      # Debug: Start line found at $error_start_line
+      error_end_line=$(tail -n +$((error_start_line + 1)) $results_file | grep -nm 1 "^-.*Captured stdout call.*-$" | cut -d: -f1)
+      if [[ ! -z "$error_start_line" ]]; then
+        error_end_line=$(tail -n +$((error_start_line + 1)) $results_file | grep -nm 1 "^-.*Captured stdout call.*-$" | cut -d: -f1)
+        if [[ ! -z "$error_end_line" ]]; then
+            # Find the end of the error block
+            absolute_error_end_line=$((error_start_line + error_end_line - 1))
+            sed -n "${error_start_line},${absolute_error_end_line}p" $results_file | sed 's/^>/\\>/'
+        fi
+      fi
+      echo "</code></details>"
+    done
+  fi
+else
+  echo "No test results found."
+fi

xsuite-0.45.8/.github/scripts/install_branches.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+# copyright ############################### #
+# This file is part of the Xsuite project.  #
+# Copyright (c) CERN, 2024.                 #
+# ######################################### #
+set -xe
+
+repos=(xobjects xdeps xpart xtrack xfields xmask xcoll xwakes)
+xsuite_prefix="${xsuite_prefix:-.}"
+
+# Expects the following environment variables:
+# - $prefix, where to clone the packages
+# - ${repo}_branch, where $repo is one of the repos above (replace - with _)
+# - $precompile_kernels set to "true" or "false"
+# - $install_mpi set to "true" or "false"
+
+# Expect Xsuite already cloned by the main workflow
+if [ "${precompile_kernels:-false}" == "false" ]; then
+  export SKIP_KERNEL_BUILD=1
+fi
+
+if [ "${install_mpi:-false}" == "true" ]; then
+  mamba install -y openmpi
+  pip install mpi4py
+fi
+
+pip install --no-deps -v -e "${xsuite_prefix}/xsuite"
+
+# Clone the repos and install them in the correct branch
+for project in "${repos[@]}"; do
+  branch_varname="${project//-/_}_branch"
+  project_branch=${!branch_varname}  # get value of the variable [project]_branch
+
+  IFS=':' read -r -a parts <<< "$project_branch"
+  user="${parts[0]}"
+  branch="${parts[1]}"
+
+  cd "$xsuite_prefix"
+  git clone \
+    --recursive \
+    --single-branch -b "$branch" \
+    "https://github.com/${user}/${project}.git"
+
+    pip install -e "${xsuite_prefix}/${project}[tests]"
+done

xsuite-0.45.8/.github/scripts/run_tests.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/bash
+# copyright ############################### #
+# This file is part of the Xsuite project.  #
+# Copyright (c) CERN, 2024.                 #
+# ######################################### #
+set -xe
+
+# Expects the path to tests folder as the first argument
+if [ $# -eq 0 ]; then
+    echo "No arguments provided. Please provide the path to the tests folder."
+    exit 1
+fi
+
+# We want the tests to be terminated (quickly!) when this script is terminated
+# GitHub gives us 7.5s before sending a SIGKILL to all child processes
+_term() {
+  echo "Received a SIGINT/SIGKILL signal. Terminating."
+  kill -TERM "$PYTEST_PID"
+}
+trap _term SIGINT SIGTERM
+
+# Pytest options
+PYTEST_OPTS="--durations=0 --durations-min=1 --color=yes --verbose $PYTEST_ADDOPTS"
+
+# Keep track of failures
+PYTEST_STATUS=0
+STATUS=0
+
+# Make nice annotations in the GitHub Actions logs
+pip install pytest-github-actions-annotate-failures
+export GITHUB_ACTIONS=true
+
+run_pytest() {
+  pytest $PYTEST_OPTS "$1" &
+  PYTEST_PID=$!
+  wait $PYTEST_PID || PYTEST_STATUS=$?
+}
+
+# Use multithreading if on cpu context and not xmask
+if [[ $XOBJECTS_TEST_CONTEXTS =~ "ContextCpu" ]] && [[ ! $* =~ xsuite/(xmask|xcoll) ]]; then
+  pip install pytest-xdist
+  PYTEST_OPTS="$PYTEST_OPTS -nauto"
+fi
+
+run_pytest "$@"
+
+# If the tests failed, set the status to 1 (5 is for no tests collected)
+if [ $PYTEST_STATUS -ne 0 ] && [ $PYTEST_STATUS -ne 5 ]; then
+  STATUS=1
+fi
+
+exit $STATUS

xsuite-0.45.8/.github/workflows/cron_test_gh.yaml

@@ -0,0 +1,20 @@
+# This is a workflow that should run daily
+name: Daily test (GitHub, CPU)
+
+# Controls when the action will run.
+on:
+  schedule:
+    - cron: '00 19 * * *'  # run at 19:00 UTC daily
+
+# This workflow calls the test_gh.yaml workflow passing the default
+# branches as inputs
+jobs:
+  run-tests-cron-gh:
+    uses: ./.github/workflows/test_gh.yaml
+    with:
+      xobjects_test_contexts: "ContextCpu"
+  run-tests-cron-gh-precompiled:
+    uses: ./.github/workflows/test_gh.yaml
+    with:
+      precompile_kernels: true
+      xobjects_test_contexts: "ContextCpu"

xsuite-0.45.8/.github/workflows/cron_test_gh_omp.yaml

@@ -0,0 +1,15 @@
+# This is a workflow that should run daily
+name: Daily test (GitHub, OpenMP)
+
+# Controls when the action will run.
+on:
+  schedule:
+    - cron: '00 19 * * *'  # run at 19:00 UTC daily
+
+# This workflow calls the test_gh.yaml workflow passing the default
+# branches as inputs
+jobs:
+  run-tests-cron-gh-omp:
+    uses: ./.github/workflows/test_gh.yaml
+    with:
+      xobjects_test_contexts: "ContextCpu:auto"

xsuite-0.45.8/.github/workflows/cron_test_gpu_cl.yaml

@@ -0,0 +1,19 @@
+# This is a workflow that should run daily
+name: Daily test (self-hosted, OpenCL)
+
+# Controls when the action will run.
+on:
+  schedule:
+    - cron: '00 19 * * *'  # run at 19:00 UTC daily
+
+# This workflow calls the test_gpu.yaml workflow passing the default
+# branches as inputs. The cron workflow will not run on forks.
+jobs:
+  run-tests-cron-gpu:
+    if: github.repository == 'xsuite/xsuite'
+    uses: ./.github/workflows/test_sh.yaml
+    with:
+      test_contexts: 'ContextPyopencl'
+      platform: 'alma'
+      suites: '["xobjects", "xdeps", "xpart", "xtrack", "xfields", "xcoll"]'
+      pytest_options: '-m context_dependent'

xsuite-0.45.8/.github/workflows/cron_test_gpu_cuda.yaml

@@ -0,0 +1,19 @@
+# This is a workflow that should run daily
+name: Daily test (self-hosted, CUDA)
+
+# Controls when the action will run.
+on:
+  schedule:
+    - cron: '00 19 * * *'  # run at 19:00 UTC daily
+
+# This workflow calls the test_gpu.yaml workflow passing the default
+# branches as inputs. The cron workflow will not run on forks.
+jobs:
+  run-tests-cron-gpu:
+    if: github.repository == 'xsuite/xsuite'
+    uses: ./.github/workflows/test_sh.yaml
+    with:
+      test_contexts: 'ContextCupy'
+      platform: 'ubuntu'
+      suites: '["xobjects", "xdeps", "xpart", "xtrack", "xfields", "xcoll"]'
+      pytest_options: '-m context_dependent'

xsuite-0.45.8/.github/workflows/cron_test_sh_cpu.yaml

@@ -0,0 +1,32 @@
+# This is a workflow that should run daily
+name: Daily test (self-hosted, CPU)
+
+# Controls when the action will run.
+on:
+  schedule:
+    - cron: '00 19 * * *'  # run at 19:00 UTC daily
+
+# This workflow calls the test_gpu.yaml workflow passing the default
+# branches as inputs. The cron workflow will not run on forks.
+jobs:
+  run-tests-cron-sh-cpu-no-xmask-serial:
+    if: github.repository == 'xsuite/xsuite'
+    uses: ./.github/workflows/test_sh.yaml
+    with:
+      test_contexts: 'ContextCpu'
+      platform: 'alma-cpu-1'
+      suites: '["xobjects", "xdeps", "xpart", "xtrack", "xfields", "xcoll", "xwakes"]'
+  run-tests-cron-sh-cpu-no-xmask-openmp:
+    if: github.repository == 'xsuite/xsuite'
+    uses: ./.github/workflows/test_sh.yaml
+    with:
+      test_contexts: 'ContextCpu:auto'
+      platform: 'alma-cpu-2'
+      suites: '["xobjects", "xdeps", "xpart", "xtrack", "xfields", "xcoll", "xwakes"]'
+  run-tests-cron-sh-cpu-xmask:
+    if: github.repository == 'xsuite/xsuite'
+    uses: ./.github/workflows/test_sh.yaml
+    with:
+      test_contexts: 'ContextCpu;ContextCpu:auto'
+      platform: 'alma-cpu-smaller'
+      suites: '["xmask"]'

xsuite-0.45.8/.github/workflows/cron_test_sh_xwakes_mpi.yaml

@@ -0,0 +1,20 @@
+# This is a workflow that should run daily
+name: Daily test (Xwakes, MPI)
+
+# Controls when the action will run.
+on:
+  schedule:
+    - cron: '00 19 * * *'  # run at 19:00 UTC daily
+  workflow_dispatch:
+
+# This workflow calls the test_gpu.yaml workflow passing the default
+# branches as inputs. The cron workflow will not run on forks.
+jobs:
+  run-tests-cron-sh-cpu-no-xmask-serial:
+    if: github.repository == 'xsuite/xsuite'
+    uses: ./.github/workflows/test_sh.yaml
+    with:
+      test_contexts: 'ContextCpu'
+      with_mpi: true
+      platform: 'alma-cpu-small-1'
+      suites: '["xwakes"]'

xsuite-0.45.8/.github/workflows/manual_test_gh.yaml

@@ -0,0 +1,43 @@
+# This is a test workflow that is manually triggered
+name: Manual test (GitHub, CPU)
+
+# Controls when the action will run. Workflow runs when manually triggered using the UI
+# or API.
+on:
+  workflow_dispatch:
+    # Inputs the workflow accepts.
+    # Specify branches using the refspec-like syntax: <user>:<branch>
+    inputs:
+      locations:
+        description: 'Branch locations (JSON array string)'
+        default: '{
+          "xobjects_location":"xsuite:main",
+          "xdeps_location":"xsuite:main",
+          "xpart_location":"xsuite:main",
+          "xtrack_location":"xsuite:main",
+          "xfields_location":"xsuite:main",
+          "xmask_location":"xsuite:main",
+          "xcoll_location":"xsuite:main",
+          "xwakes_location":"xsuite:main"
+        }'
+        required: true
+        type: string
+      precompile_kernels:
+        description: 'precompile kernels?'
+        type: boolean
+        default: false
+        required: true
+      xobjects_test_contexts:
+        description: xobjects test contexts
+        default: "ContextCpu;ContextCpu:auto"
+        required: true
+
+# This workflow calls the test_gh.yaml workflow passing the specified
+# branches as inputs
+jobs:
+  run-tests-manual-gh:
+    uses: ./.github/workflows/test_gh.yaml
+    with:
+      locations: ${{ inputs.locations }}
+      precompile_kernels: ${{ inputs.precompile_kernels }}
+      xobjects_test_contexts: ${{ inputs.xobjects_test_contexts }}

xsuite-0.45.8/.github/workflows/manual_test_sh.yaml

@@ -0,0 +1,55 @@
+# This is a test workflow that is manually triggered
+name: Manual test (self-hosted)
+run-name: Manual test (${{ inputs.platform }}, ${{ inputs.test_contexts }})
+
+# Controls when the action will run. Workflow runs when manually triggered using the UI
+# or API.
+on:
+  workflow_dispatch:
+    # Inputs the workflow accepts.
+    # Specify branches using the refspec-like syntax: <user>:<branch>
+    inputs:
+      locations:
+        description: 'Branch locations (JSON array string)'
+        default: '{
+          "xobjects_location":"xsuite:main",
+          "xdeps_location":"xsuite:main",
+          "xpart_location":"xsuite:main",
+          "xtrack_location":"xsuite:main",
+          "xfields_location":"xsuite:main",
+          "xmask_location":"xsuite:main",
+          "xcoll_location":"xsuite:main",
+          "xwakes_location":"xsuite:main"
+        }'
+        required: true
+        type: string
+      pytest_options:
+        description: Command to run tests
+        required: false
+        type: string
+      test_contexts:
+        description: test contexts
+        default: 'ContextCpu;ContextCpu:auto;ContextCupy;ContextPyopencl'
+        required: false
+      platform:
+        description: platform
+        default: 'ubuntu'
+        required: true
+      suites:
+        description: test suites (JSON array string)
+        required: true
+        type: string
+        default: '["xobjects", "xdeps", "xpart", "xtrack", "xfields", "xmask", "xcoll", "xwakes"]'
+
+# This workflow calls the test_sh.yaml workflow passing the specified
+# branches as inputs
+jobs:
+  run-tests-manual-sh:
+    uses: ./.github/workflows/test_sh.yaml
+    secrets: inherit
+    with:
+      locations: ${{ inputs.locations }}
+      pytest_options: ${{ inputs.pytest_options }}
+      test_contexts: ${{ inputs.test_contexts }}
+      platform: ${{ inputs.platform }}
+      suites: ${{ inputs.suites }}

xsuite-0.45.8/.github/workflows/release.yaml

@@ -0,0 +1,84 @@
+name: Release
+run-name: Release ${{ github.ref_name }}
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build-wheels:
+    name: Build wheels for ${{ matrix.pyver }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [
+          ubuntu-latest,
+          macos-15-intel,  # x86_64 runners for building x86 wheels
+          macos-latest,  # arm64 runners
+        ]
+        pyver: [cp310, cp311, cp312, cp313, cp314]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel
+
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_BUILD: ${{ matrix.pyver }}-*
+          CIBW_ENVIRONMENT_PASS_LINUX: LDFLAGS
+          LDFLAGS: "-Wl,-S"  # Strip debug symbols: otherwise added by manylinux
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  build-sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-sdist
+          path: dist/*.tar.gz
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build-wheels, build-sdist]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/xsuite
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Check tag is a public release
+      id: check-tag
+      run: |
+        # Only if a tag matches the pattern vX.Y.Z, upload to PyPI
+        if [[ ${{ github.event.ref }} =~ ^refs/tags/v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "match=true" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Download all the dists
+      if: steps.check-tag.outputs.match == 'true'
+      uses: actions/download-artifact@v4
+      with:
+        pattern: dist-*
+        path: dist
+        merge-multiple: true
+
+    - name: Publish to PyPI
+      if: steps.check-tag.outputs.match == 'true'
+      uses: pypa/gh-action-pypi-publish@release/v1

xsuite-0.45.8/.github/workflows/test_gh.yaml

@@ -0,0 +1,105 @@
+# This is a test workflow the other (GitHub runner based) workflows rely on
+name: Test workflow (GitHub, CPU)
+
+# Controls when the action will run. This is a reusable workflow.
+on:
+  workflow_call:
+    # Inputs the workflow accepts.
+    inputs:
+      locations:
+        description: 'Branch locations (JSON array string)'
+        default: '{
+          "xobjects_location":"xsuite:main",
+          "xdeps_location":"xsuite:main",
+          "xpart_location":"xsuite:main",
+          "xtrack_location":"xsuite:main",
+          "xfields_location":"xsuite:main",
+          "xmask_location":"xsuite:main",
+          "xcoll_location":"xsuite:main",
+          "xwakes_location":"xsuite:main"
+        }'
+        required: false
+        type: string
+      precompile_kernels:
+        required: false
+        default: false
+        type: boolean
+      xobjects_test_contexts:
+        required: false
+        default: "ContextCpu;ContextCpu:auto"
+        type: string
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+# The jobs are all run in independent environments. Here we will run a separate job
+# for each of the test suites specified in the matrix below.
+jobs:
+  run-tests:
+    # The type of runner that the job will run on: this one is provided by GitHub
+    runs-on: ubuntu-latest
+    
+    # Run tests for all the xsuite packages in separate jobs in parallel
+    strategy:
+      fail-fast: false
+      matrix:
+        test-suite: 
+          - xobjects
+          - xdeps
+          - xpart
+          - xtrack
+          - xfields
+          - xmask
+          - xcoll
+          - xwakes
+    
+    # Make the default shell a login shell, so that conda is initialised properly
+    defaults:
+      run:
+        shell: bash -el {0}
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    - name: Set up dynamic swapping
+      run: |
+        sudo swapoff -a
+        sudo apt-get install -y swapspace
+        sudo systemctl start swapspace.service
+        df -h
+    - name: Setup Miniforge
+      uses: conda-incubator/setup-miniconda@v2
+      with:
+        miniforge-version: latest
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        conda install openmp
+        pip install cython
+    - name: Checkout xsuite
+      uses: actions/checkout@v4
+      with:
+        path: xsuite
+    - name: Check out xsuite repos & pip install
+      env:
+        precompile_kernels: ${{ inputs.precompile_kernels }}
+      run: |
+        export xobjects_branch=${{ fromJson(inputs.locations).xobjects_location }} 
+        export xdeps_branch=${{ fromJson(inputs.locations).xdeps_location }}
+        export xpart_branch=${{ fromJson(inputs.locations).xpart_location }} 
+        export xtrack_branch=${{ fromJson(inputs.locations).xtrack_location }}
+        export xfields_branch=${{ fromJson(inputs.locations).xfields_location }} 
+        export xmask_branch=${{ fromJson(inputs.locations).xmask_location }}
+        export xcoll_branch=${{ fromJson(inputs.locations).xcoll_location }}
+        export xwakes_branch=${{ fromJson(inputs.locations).xwakes_location }}
+        export xsuite_prefix="$GITHUB_WORKSPACE" 
+        bash $GITHUB_WORKSPACE/xsuite/.github/scripts/install_branches.sh
+    - name: Precompile kernels
+      if: ${{ inputs.precompile_kernels == true }}
+      run: |
+        xsuite-prebuild r
+    - name: Print versions
+      run: conda list
+    - name: Run tests (${{ matrix.test-suite }})
+      env:
+        XOBJECTS_TEST_CONTEXTS: ${{ inputs.xobjects_test_contexts }}
+      run: |
+        cd $GITHUB_WORKSPACE/${{ matrix.test-suite }}
+        python -m pytest --color=yes -v tests