Metadata-Version: 2.3
Name: irnl_rdt_correction
Version: 1.1.2
Summary: Correction script to power the nonlinear correctors in the (HL-)LHC insertion regions based on RDTs.
Project-URL: homepage, https://github.com/pylhc/irnl_rdt_correction
Project-URL: repository, https://github.com/pylhc/irnl_rdt_correction
Project-URL: documentation, https://pylhc.github.io/irnl_rdt_correction/
Project-URL: changelog, https://github.com/pylhc/irnl_rdt_correction/releases
Author-email: OMC Team <pylhc@github.com>
License-Expression: MIT
License-File: LICENSE
Keywords: accelerator,correction,hl-lhc,lhc,nonlinear
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: numpy<2.0,>=1.19; python_version < '3.10'
Requires-Dist: numpy>=1.19; python_version >= '3.10'
Requires-Dist: pandas!=1.2,>=1.0
Requires-Dist: tfs-pandas>=3.0.2
Provides-Extra: all
Requires-Dist: h5py>=2.9.0; extra == 'all'
Requires-Dist: pytest-cov>=2.9; extra == 'all'
Requires-Dist: pytest>=7.0; extra == 'all'
Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'all'
Requires-Dist: sphinx>=7.0; extra == 'all'
Requires-Dist: tables>=3.9; extra == 'all'
Provides-Extra: doc
Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'doc'
Requires-Dist: sphinx>=7.0; extra == 'doc'
Provides-Extra: test
Requires-Dist: h5py>=2.9.0; extra == 'test'
Requires-Dist: pytest-cov>=2.9; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Requires-Dist: tables>=3.9; extra == 'test'
Description-Content-Type: text/markdown

# IRNL RDT Correction 

[![Cron Testing](https://github.com/pylhc/irnl_rdt_correction/workflows/Cron%20Testing/badge.svg)](https://github.com/pylhc/irnl_rdt_correction/actions?query=workflow%3A%22Cron+Testing%22)
[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/pylhc/irnl_rdt_correction.svg?style=popout)](https://codeclimate.com/github/pylhc/irnl_rdt_correction)
[![Code Climate maintainability (percentage)](https://img.shields.io/codeclimate/maintainability-percentage/pylhc/irnl_rdt_correction.svg?style=popout)](https://codeclimate.com/github/pylhc/irnl_rdt_correction)
[![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/irnl_rdt_correction.svg?style=popout)](https://github.com/pylhc/irnl_rdt_correction/)
[![GitHub release](https://img.shields.io/github/release/pylhc/irnl_rdt_correction.svg?style=popout)](https://github.com/pylhc/irnl_rdt_correction/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6373374.svg)](https://doi.org/10.5281/zenodo.6373374)

Performs local correction of the Resonance Driving Terms (RDTs)
in the Insertion Regions (IRs) based on the principle described in
[[1]](#1) with the addition of correcting
feed-down and using feed-down to correct lower order RDTs.
Details can be found in [[2]](#2).


## Documentation

- The note containing background, derivation and implementation details can be found in the attached [note](latex/note.pdf).
- Autogenerated docs via `Sphinx` can be found at <https://pylhc.github.io/irnl_rdt_correction/>.

## Installing

This package is `Python 3.7+` compatible, and can be installed through `pip`:
```bash
python -m pip install irnl-rdt-correction
```

After installing, scripts can be run with either `python -m irnl_rdt_correction --FLAG ARGUMENT` or by calling the Python files directly.

For development purposes, we recommend creating a new virtual environment and installing from VCS in editable mode with all extra dependencies:
```bash
git clone https://github.com/pylhc/irnl_rdt_correction
python -m pip install --editable "irnl_rdt_correction[all]"
```

## Main Script 

-  [**irnl_rdt_correction.py**](irnl_rdt_correction/main.py) - Script to compute RDT correction in the (HL)LHC IRs including feed-down effects.

## License

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


## References

<a id="1">[1]</a> :
O. Bruening et al.,
Dynamic aperture studies for the LHC separation dipoles. (2004)
https://cds.cern.ch/record/742967

<a id="2">[2]</a> :
J. Dilly and R. Tomás,
A flexible nonlinear Resonance Driving Term based Correction Algorithm with feed-down. (2022)
[note.pdf](latex/note.pdf)

