Metadata-Version: 2.1
Name: xcoll
Version: 0.5.10
Summary: Xsuite collimation package
Home-page: https://github.com/xsuite/xcoll
License: Apache 2.0
Author: Frederik F. Van der Veken
Author-email: frederik@cern.ch
Requires-Python: >=3.8
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: tests
Requires-Dist: numpy (>=1.0)
Requires-Dist: pandas (>=1.4)
Requires-Dist: ruamel-yaml (>=0.17.31,<0.18.0) ; extra == "tests"
Requires-Dist: xdeps (>=0.7.4)
Requires-Dist: xobjects (>=0.4.5)
Requires-Dist: xpart (>=0.19.1)
Requires-Dist: xtrack (>=0.69.7)
Project-URL: Repository, https://github.com/xsuite/xcoll
Description-Content-Type: text/markdown

# xcoll

<!---![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xcoll?logo=PyPI?style=plastic) ![PyPI - Wheel](https://img.shields.io/pypi/wheel/xcoll?logo=PyPI?style=plastic)-->

![GitHub release (latest by date)](https://img.shields.io/github/v/release/xsuite/xcoll?style=plastic)
![GitHub](https://img.shields.io/github/license/xsuite/xcoll?style=plastic)
![PyPi](https://img.shields.io/pypi/dm/xcoll?logo=PyPI&style=plastic)
![GitHub all releases](https://img.shields.io/github/downloads/xsuite/xcoll/total?logo=GitHub&style=plastic)

![GitHub pull requests](https://img.shields.io/github/issues-pr/xsuite/xcoll?logo=GitHub&style=plastic)
![GitHub issues](https://img.shields.io/github/issues/xsuite/xcoll?logo=GitHub&style=plastic)
![GitHub repo size](https://img.shields.io/github/repo-size/xsuite/xcoll?logo=GitHub&style=plastic)

Collimation in xtrack simulations

## Description

## Getting Started

### Dependencies

* python >= 3.8
    * numpy
    * pandas
    * xsuite (in particular xobjects, xdeps, xtrack, xpart)

### Installing
`xcoll` is packaged using `poetry`, and can be easily installed with `pip`:
```bash
pip install xcoll
```
For a local installation, clone and install in editable mode (need to have `pip` >22):
```bash
git clone git@github.com:xsuite/xcoll.git
pip install -e xcoll
```

### Example

## Features

## Authors

* [Frederik Van der Veken](https://github.com/freddieknets) (frederik@cern.ch)
* [Despina Demetriadou](https://github.com/ddemetriadou)
* [Andrey Abramov](https://github.com/anabramo)
* [Giovanni Iadarola](https://github.com/giadarol)


## Version History

* 0.1
    * Initial Release

## License

This project is [Apache 2.0 licensed](./LICENSE).

