xcoll 0.1.2

Xsuite collimation package

xcoll

Collimation in xtrack simulations

Description

Getting Started

Dependencies

• python >= 3.8
  • numpy
  • pandas
  • xsuite (in particular xobjects, xdeps, xtrack, xpart)
• to use K2:
  • gfortran

Installing

xcoll is packaged using poetry, and can be easily installed with pip:

pip install xcoll

For a local installation, clone and install in editable mode (need to have pip >22):

git clone [e-mail]:xsuite/xcoll.git
pip install -e xcoll

Using K2

To be able to use the K2 scattering algorithms, these need to be compiled from source. There is a small script that does this (you can ignore the warnings):

cd xcoll
./compile_K2.sh

This installs a shared library in the package that is tailored to your current python installation.

Without compilation, K2 Collimators can be installed in a Line, but not tracked.

Example

Features

Authors

• Frederik Van der Veken ([e-mail])
• Despina Demetriadou
• Andrey Abramov
• Giovanni Iadarola

Version History

• 0.1
  • Initial Release

License

This project is Apache 2.0 licensed.