Metadata-Version: 2.1
Name: pyrws
Version: 0.4.0
Summary: Python Package to Prepare Rigid Waist Shift Operations in the CCC.
Project-URL: homepage, https://github.com/fsoubelet/pyrws
Project-URL: repository, https://github.com/fsoubelet/pyrws
Project-URL: documentation, https://fsoubelet.github.io/pyrws
Author-email: Felix Soubelet <felix.soubelet@cern.ch>
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.8
Requires-Dist: click>=8.0
Requires-Dist: cpymad>=1.9.0
Requires-Dist: loguru>=0.5.0
Requires-Dist: matplotlib>=3.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: pandas>=1.0
Requires-Dist: pyhdtoolkit>=1.0.0
Requires-Dist: rich-click>=1.0
Requires-Dist: tfs-pandas>=3.2.0
Provides-Extra: dev
Requires-Dist: black>=22.1; extra == 'dev'
Requires-Dist: isort>=5.10; extra == 'dev'
Requires-Dist: pylint>=2.4; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-click>3.0; extra == 'docs'
Requires-Dist: sphinx-copybutton<1.0; extra == 'docs'
Requires-Dist: sphinx-panels<1.0; extra == 'docs'
Requires-Dist: sphinx-prompt>=1.5; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=1.0; extra == 'docs'
Requires-Dist: sphinx>=4.4; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex>=2.4; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest-cov>=3.0; extra == 'test'
Requires-Dist: pytest>=6.0; extra == 'test'
Description-Content-Type: text/markdown

# PyRWS

[![GitHub last commit](https://img.shields.io/github/last-commit/fsoubelet/pyrws.svg?style=popout)](https://github.com/fsoubelet/pyrws/)
[![PyPI Version](https://img.shields.io/pypi/v/pyrws?label=PyPI&logo=pypi)](https://pypi.org/project/pyrws/)
[![GitHub release](https://img.shields.io/github/v/release/fsoubelet/pyrws?logo=github)](https://github.com/fsoubelet/pyrws/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6517667.svg)](https://doi.org/10.5281/zenodo.6517667)



This is a `Python 3.8+` package that provides functionality to create Rigid Waist Shift Knobs to be used for for IR local coupling correction in the LHC commissioning 2022.
A bit more information can be found on the OMC website's page for [the procedure](https://pylhc.github.io/measurements/procedures/rigid_waist_shift/).

See the [API documentation](https://fsoubelet.github.io/pyrws/) for details.

## Installing

Installation is easily done via `pip`:
```bash
python -m pip install pyrws
```

## Example Usage

 The package is meant to be used at the command line.
```bash
python -m pyrws \
  --sequence acc-models-lhc/lhc.seq \
  --opticsfile acc-models-lhc/operation/optics/R2022a_A30cmC30cmA10mL200cm.madx \
  --ip 1 \
  --waist_shift_setting 1 \
  --outputdir 30cm \
  --energy 6800 \
  --show_plots no \
```

Individual parts of the package can be imported to be used in a Python program, or as utilities to load and inspect the outputs of some knob generation.
For details, see the API documentation website.

## License

This project is licensed under the `MIT License` - see the [LICENSE](LICENSE) file for details.