Xsuite collimation package
Project description
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 git@github.com: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
Version History
- 0.1
- Initial Release
License
This project is Apache 2.0 licensed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xcoll-0.1.2.tar.gz
(229.2 kB
view hashes)
Built Distribution
xcoll-0.1.2-py3-none-any.whl
(259.4 kB
view hashes)