https://github.com/pylhc/irnl_rdt_correction

Correction script to power the nonlinear correctors in the (HL-)LHC insertion regions based on RDTs.
https://github.com/pylhc/irnl_rdt_correction

accelerator correction hl-lhc lhc nonlinear

Last synced: about 1 month ago
JSON representation

Correction script to power the nonlinear correctors in the (HL-)LHC insertion regions based on RDTs.

• Host: GitHub
• URL: https://github.com/pylhc/irnl_rdt_correction
• Owner: pylhc
• License: mit
• Created: 2022-03-16T09:02:19.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T14:08:23.000Z (about 1 year ago)
• Last Synced: 2025-07-09T13:12:03.360Z (4 months ago)
• Topics: accelerator, correction, hl-lhc, lhc, nonlinear
• Language: TeX
• Homepage: https://pylhc.github.io/irnl_rdt_correction/
• Size: 43.6 MB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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 .

## 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

[1] :

O. Bruening et al.,

Dynamic aperture studies for the LHC separation dipoles. (2004)

https://cds.cern.ch/record/742967

[2] :

J. Dilly and R. Tomás,

A flexible nonlinear Resonance Driving Term based Correction Algorithm with feed-down. (2022)

[note.pdf](latex/note.pdf)