Metadata-Version: 2.4
Name: accelerator-commissioning
Version: 1.1.0
Summary: A Python Simulated Commissioning toolkit for synchrotrons (inspired by https://github.com/ThorstenHellert/SC)
Project-URL: Homepage, https://github.com/kparasch/pySC
Project-URL: Repository, https://github.com/kparasch/pySC.git
Maintainer-email: Konstantinos Paraschou <konstantinos.paraschou@desy.de>
License-File: LICENSE
Keywords: Accelerator,Commissioning,Synchrotron
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Requires-Dist: accelerator-toolbox>=0.6.1
Requires-Dist: h5py
Requires-Dist: matplotlib>=3.7.3
Requires-Dist: numpy>=2.0.0
Requires-Dist: pydantic
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: rich
Requires-Dist: scipy>=1.11.4
Provides-Extra: doc
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-rtd-theme; extra == 'doc'
Requires-Dist: travis-sphinx; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest-cov>=3.0; extra == 'test'
Requires-Dist: pytest>=7.4; extra == 'test'
Description-Content-Type: text/markdown

# pySC

Python Simulated Commissioning toolkit for synchrotrons.

## Installing

```bash
pip install accelerator-commissioning
```

## Importing specific modules

Intended way of importing a pySC functionality:

```
from pySC import SimulatedCommissioning
from pySC import generate_SC

from pySC import ResponseMatrix

from pySC import orbit_correction
from pySC import measure_bba
from pySC import measure_ORM
from pySC import measure_dispersion

from pySC import pySCInjectionInterface
from pySC import pySCOrbitInterface

# the following disables rich progress bars (doesn't work well with )
from pySC import disable_pySC_rich
disable_pySC_rich()
```


## Acknowledgements

This toolkit was inspired by [SC](https://github.com/ThorstenHellert/SC) which is written in Matlab.
