add kickgroups and move IRNL to separate tab (#72)

Co-authored-by: Felix Soubelet <19598248+fsoubelet@users.noreply.github.com>

docs/packages/irnl/about.md

@@ -0,0 +1,42 @@
+# IRNL RDT Correction
+
+[This package][repo] performs local correction of the Resonance Driving Terms (RDTs) in the Insertion Regions (IRs) based on the principle described in [^OBruning] with the addition of correcting feed-down and using feed-down to correct lower order RDTs. Details can be found in [^JDilly].
+
+
+## Documentation
+
+- [Autogenerated docs][documentation] via ``sphinx``.
+
+## Getting Started
+
+This  package is `Python 3.7+` compatible, and can be installed through `pip`:
+
+```bash
+python -m pip install irnl-rdt-correction
+```
+
+After installing, codes can be run with either `python -m irnl-rdt-correction --FLAG ARGUMENT` or calling path to the `.py` file directly.
+
+[repo]: https://github.com/pylhc/irnl_rdt_correction
+[documentation]: https://pylhc.github.io/irnl_rdt_correction/
+
+
+
+[^OBruning]:
+    ??? abstract "Dynamic aperture studies for the LHC separation dipoles, `O. Bruning et al. `, [https://cds.cern.ch/record/742967](https://cds.cern.ch/record/742967){target=_blank}"
+        ```
+        @techreport{Brüning:742967,
+            author        = "Brüning, Oliver Sim and Fartoukh, Stéphane David and
+                            Giovannozzi, Massimo and Risselada, Thys",
+            title         = "{Dynamic Aperture Studies for the LHC Separation Dipoles}",
+            institution   = "CERN",
+            address       = "Geneva",
+            reportNumber  = "LHC-Project-Note-349, CERN-LHC-Project-Note-349",
+            month         = "Jun",
+            year          = "2004",
+            url           = "https://cds.cern.ch/record/742967",
+        }
+        ```
+
+[^JDilly]:
+    ??? abstract "Corrections of high-order nonlinear errors in the LHC and HL-LHC insertion regions, `J. Dilly et al.`, to be published"

docs/packages/pylhc/about.md

@@ -9,7 +9,7 @@ It provides tools which can be useful for working with accelerators, but are not
 - [*Machine Settings Info*](machine_settings_info.md) - Prints an overview over the machine settings at a given time.
 - [*BSRT Logger* and *BSRT Analysis*](bsrt.md) - Saves data coming straight from LHC BSRT FESA class and allows subsequent analysis.
 - [*BPM Calibration*](bpm_calibration.md) - Script to compute the calibration factors for the LHC BPMs.
-- [*IR NonLinear RDT Correction*](irnl_correction.md) - Script to compute RDT correction in the (HL)LHC IRs including feed-down effects.
+- [*Display Kickgroups*](kickgroups.md) - Script to load kick groups and display relevant information.
 
 ## Documentation
 

docs/packages/pylhc/kickgroups.md

@@ -0,0 +1,14 @@
+# Display kickgroups
+
+
+!!! todo
+    Description of a typical use-case, with easy examples for first-timers.
+
+[See the docs][documentation] for a detailed code description.
+
+Loads available kick-groups in a folder and displays relevant information.
+
+
+[documentation]: https://pylhc.github.io/PyLHC/index.html
+
+*[kick-groups]: list of beam excitations performed that represent either the same machine state or are paired for ease of analysis

mkdocs.yml

@@ -130,13 +130,16 @@ nav:
       - Machine Settings Info: packages/pylhc/machine_settings_info.md
       - BSRT Logger/Analysis: packages/pylhc/bsrt.md
       - BPM Calibration: packages/pylhc/bpm_calibration.md
-      - IRNL Correction: packages/pylhc/irnl_correction.md
+      - Display Kickgroups: packages/pylhc/kickgroups.md
       - ↪ On Github: https://github.com/pylhc/PyLHC
     - PyLHC-Submitter: 
       - About: packages/pylhcsubmitter/about.md
       - Job Submitter: packages/pylhcsubmitter/job_submitter.md
       - AutoSix: packages/pylhcsubmitter/autosix.md
       - ↪ On Github: https://github.com/pylhc/submitter
+    - IRNL Corrections: 
+      - About: packages/irnl/about.md
+      - ↪ On Github: https://github.com/pylhc/irnl_rdt_correction
     - MESS:
       - About: packages/mess/about.md
       - ↪ On Github: https://github.com/pylhc/MESS