Metadata-Version: 2.1
Name: collider-check
Version: 0.2.5
Summary: A small package that provides functions to check the observables in a collider, using a collider built with Xsuite.
Author-email: Colas Droin <colas.noe.droin@cern.ch>
License: MIT License
        
        Copyright (c) [2023] [Colas Droin]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/ColasDroin/collider_check
Keywords: xsuite,accelerator,collider
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: xtrack
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: matplotlib
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pandas; extra == "dev"

# Collider-check Package

## Overview

A small package that provides functions to check the observables in a collider, using a collider
built with [Xsuite](https://github.com/xsuite) as input (must be a json file). Very useful for
debugging purposes before/after tracking, and used as a backend of the [simulation dashboard](https://github.com/ColasDroin/simulation-dashboard).

## Installation

The package is available from PyPI, so you can install it with pip:

```bash
pip install collider-check
```

## Usage

You can import the package in your python script and load a collider with:

```python
import collider_check
check = collider_check.from_json("path/to/collider.json")
```

To get a quick summary of the collider observables, use:

```python
check.output_check_as_str('output.txt')
```
