# IRNL RDT Correction
[](https://github.com/pylhc/irnl_rdt_correction/actions?query=workflow%3A%22Cron+Testing%22)
[](https://codeclimate.com/github/pylhc/irnl_rdt_correction)
[](https://codeclimate.com/github/pylhc/irnl_rdt_correction)
[](https://github.com/pylhc/irnl_rdt_correction/)
[](https://github.com/pylhc/irnl_rdt_correction/)
[](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)
Raw data
{
"_id": null,
"home_page": null,
"name": "irnl-rdt-correction",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "accelerator, correction, hl-lhc, lhc, nonlinear",
"author": null,
"author_email": "OMC Team <pylhc@github.com>",
"download_url": "https://files.pythonhosted.org/packages/19/0e/20665050a5785cc4282297ad2726af3f88de672e6b0af13a64bdcef9e76f/irnl_rdt_correction-1.1.2.tar.gz",
"platform": null,
"description": "# IRNL RDT Correction \n\n[](https://github.com/pylhc/irnl_rdt_correction/actions?query=workflow%3A%22Cron+Testing%22)\n[](https://codeclimate.com/github/pylhc/irnl_rdt_correction)\n[](https://codeclimate.com/github/pylhc/irnl_rdt_correction)\n[](https://github.com/pylhc/irnl_rdt_correction/)\n[](https://github.com/pylhc/irnl_rdt_correction/)\n[](https://doi.org/10.5281/zenodo.6373374)\n\nPerforms local correction of the Resonance Driving Terms (RDTs)\nin the Insertion Regions (IRs) based on the principle described in\n[[1]](#1) with the addition of correcting\nfeed-down and using feed-down to correct lower order RDTs.\nDetails can be found in [[2]](#2).\n\n\n## Documentation\n\n- The note containing background, derivation and implementation details can be found in the attached [note](latex/note.pdf).\n- Autogenerated docs via `Sphinx` can be found at <https://pylhc.github.io/irnl_rdt_correction/>.\n\n## Installing\n\nThis package is `Python 3.7+` compatible, and can be installed through `pip`:\n```bash\npython -m pip install irnl-rdt-correction\n```\n\nAfter installing, scripts can be run with either `python -m irnl_rdt_correction --FLAG ARGUMENT` or by calling the Python files directly.\n\nFor development purposes, we recommend creating a new virtual environment and installing from VCS in editable mode with all extra dependencies:\n```bash\ngit clone https://github.com/pylhc/irnl_rdt_correction\npython -m pip install --editable \"irnl_rdt_correction[all]\"\n```\n\n## Main Script \n\n- [**irnl_rdt_correction.py**](irnl_rdt_correction/main.py) - Script to compute RDT correction in the (HL)LHC IRs including feed-down effects.\n\n## License\n\nThis project is licensed under the `MIT` License - see the [LICENSE](LICENSE) file for details.\n\n\n## References\n\n<a id=\"1\">[1]</a> :\nO. Bruening et al.,\nDynamic aperture studies for the LHC separation dipoles. (2004)\nhttps://cds.cern.ch/record/742967\n\n<a id=\"2\">[2]</a> :\nJ. Dilly and R. Tom\u00e1s,\nA flexible nonlinear Resonance Driving Term based Correction Algorithm with feed-down. (2022)\n[note.pdf](latex/note.pdf)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Correction script to power the nonlinear correctors in the (HL-)LHC insertion regions based on RDTs.",
"version": "1.1.2",
"project_urls": {
"changelog": "https://github.com/pylhc/irnl_rdt_correction/releases",
"documentation": "https://pylhc.github.io/irnl_rdt_correction/",
"homepage": "https://github.com/pylhc/irnl_rdt_correction",
"repository": "https://github.com/pylhc/irnl_rdt_correction"
},
"split_keywords": [
"accelerator",
" correction",
" hl-lhc",
" lhc",
" nonlinear"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd6e300b804395d778999b2812c558dacd02f1742becf3e77e2389107eeafa5d",
"md5": "0273f9f66429f2777f3ce5bcbd6e13a5",
"sha256": "07c8b52521389c730200a7382d72eead86040fea6332096c343c515fa027b1bf"
},
"downloads": -1,
"filename": "irnl_rdt_correction-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0273f9f66429f2777f3ce5bcbd6e13a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 27912,
"upload_time": "2024-10-28T14:08:54",
"upload_time_iso_8601": "2024-10-28T14:08:54.607334Z",
"url": "https://files.pythonhosted.org/packages/fd/6e/300b804395d778999b2812c558dacd02f1742becf3e77e2389107eeafa5d/irnl_rdt_correction-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "190e20665050a5785cc4282297ad2726af3f88de672e6b0af13a64bdcef9e76f",
"md5": "82df8d51704bc2566a790c75425292e3",
"sha256": "1fc70cb27c83dc48f54b6497caa9e563612de8b8b77eeab2867e5a7b06c099eb"
},
"downloads": -1,
"filename": "irnl_rdt_correction-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "82df8d51704bc2566a790c75425292e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1473311,
"upload_time": "2024-10-28T14:08:56",
"upload_time_iso_8601": "2024-10-28T14:08:56.510552Z",
"url": "https://files.pythonhosted.org/packages/19/0e/20665050a5785cc4282297ad2726af3f88de672e6b0af13a64bdcef9e76f/irnl_rdt_correction-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 14:08:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pylhc",
"github_project": "irnl_rdt_correction",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "irnl-rdt-correction"
}
JSON
