Knob extractor 2025 (#505)

* added new knobs
* version bump
* fixed tests

Author: JoschD

CHANGELOG.md

@@ -1,5 +1,10 @@
 # OMC3 Changelog
 
+#### 2025-04-21 - v0.24.2 - _jdilly_
+
+- Fixed:
+  - `knob_extractor` added new knobs for 2025.
+
 #### 2025-04-04 - v0.24.1 - _jdilly_
 
 - Added:

omc3/__init__.py

@@ -11,7 +11,7 @@
 __title__ = "omc3"
 __description__ = "An accelerator physics tools package for the OMC team at CERN."
 __url__ = "https://github.com/pylhc/omc3"
-__version__ = "0.24.1"
+__version__ = "0.24.2"
 __author__ = "pylhc"
 __author_email__ = "[email protected]"
 __license__ = "MIT"

omc3/knob_extractor.py

@@ -102,7 +102,7 @@
 
 LOGGER = get_logger(__name__)
 
-AFS_ACC_MODELS_LHC = Path("/afs/cern.ch/eng/acc-models/lhc/current")
+AFS_ACC_MODELS_LHC = Path("/afs/cern.ch/eng/acc-models/lhc/current")  # make sure 'current' linked correctly!
 ACC_MODELS_LHC = Path("acc-models-lhc")
 KNOBS_FILE_ACC_MODELS = ACC_MODELS_LHC / "operation" / "knobs.txt"
 KNOBS_FILE_AFS = AFS_ACC_MODELS_LHC / "operation" / "knobs.txt"
@@ -166,10 +166,17 @@ class Head:
     ],
     "disp": [
         "LHCBEAM:IP1-SDISP-CORR-SEP",
-        "LHCBEAM:IP1-SDISP-CORR-XING",
         "LHCBEAM:IP5-SDISP-CORR-SEP",
-        "LHCBEAM:IP5-SDISP-CORR-XING",
-        # hint: these knobs do not exist for IP2 and IP8
+        "LHCBEAM:IP1-SDISP-CORR-XING-H",
+        "LHCBEAM:IP1-SDISP-CORR-XING-V",
+        "LHCBEAM:IP5-SDISP-CORR-XING-H",
+        "LHCBEAM:IP5-SDISP-CORR-XING-V",
+        # "LHCBEAM:IP2-SDISP-CORR-XING-H",  # does not exist in knobs.txt
+        "LHCBEAM:IP2-SDISP-CORR-XING-V",
+        "LHCBEAM:IP8-SDISP-CORR-XING-H",
+        "LHCBEAM:IP8-SDISP-CORR-XING-V",
+        "LHCBEAM1:IP-SDISP-QPBUMP",
+        "LHCBEAM2:IP-SDISP-QPBUMP",
     ],
     "mo": [
         "LHCBEAM1:LANDAU_DAMPING",
@@ -196,6 +203,10 @@ class Head:
         "LHCBEAM2:IP8_SEPSCAN_X_MM",
         "LHCBEAM2:IP8_SEPSCAN_Y_MM",
     ],
+    # "dpp": [  % maybe extract at injection?
+    #     "LHCBEAM1:DP_TRIM_PERMIL",
+    #     "LHCBEAM2:DP_TRIM_PERMIL"
+    # ],
 }
 
 USAGE_EXAMPLES = """Usage Examples:

tests/inputs/knob_extractor/knob_definitions.txt

@@ -68,9 +68,9 @@ on_sep1_h, LHCBEAM/IP1-SEP-H-MM, 1.0, 2.0
 on_sep2h, LHCBEAM/IP2-SEP-H-MM, 1.0, 2.0
 on_sep5_v, LHCBEAM/IP5-SEP-V-MM, 1.0, 2.0
 on_sep8v, LHCBEAM/IP8-SEP-V-MM, 1.0, 2.0
-on_sep1_v, LHCBEAM/IP1-SEP-V-MM, -1.0, 2.0
+on_sep1_v, LHCBEAM/IP1-SEP-V-MM, 1.0, 2.0
 on_sep2v, LHCBEAM/IP2-SEP-V-MM, 1.0, 2.0
-on_sep5_h, LHCBEAM/IP5-SEP-H-MM, -1.0, 2.0
+on_sep5_h, LHCBEAM/IP5-SEP-H-MM, 1.0, 2.0
 on_sep8h, LHCBEAM/IP8-SEP-H-MM, 1.0, 2.0
 
 # IP Crossing Angles
@@ -85,9 +85,16 @@ on_x8v, LHCBEAM/IP8-XING-V-MURAD, 1.0, 150.0
 
 # ON_DISP KNOBS
 on_ssep1_h, LHCBEAM/IP1-SDISP-CORR-SEP, 1.0, 2.0
-on_xx1_v, LHCBEAM/IP1-SDISP-CORR-XING, 1.0, 100.0
 on_ssep5_v, LHCBEAM/IP5-SDISP-CORR-SEP, 1.0, 2.0
-on_xx5_h, LHCBEAM/IP5-SDISP-CORR-XING, 1.0, 100.0
+on_xx1_h, LHCBEAM/IP1-SDISP-CORR-XING-H, 1.0, 100.0
+on_xx1_v, LHCBEAM/IP1-SDISP-CORR-XING-V, 1.0, 100.0
+on_xx2v, LHCBEAM/IP2-SDISP-CORR-XING-V, 1.0, 100.0
+on_xx5_h, LHCBEAM/IP5-SDISP-CORR-XING-H, 1.0, 100.0
+on_xx5_v, LHCBEAM/IP5-SDISP-CORR-XING-V, 1.0, 100.0
+on_xx8h, LHCBEAM/IP8-SDISP-CORR-XING-H, 1.0, 100.0
+on_xx8v, LHCBEAM/IP8-SDISP-CORR-XING-V, 1.0, 100.0
+on_qpbump.b1, LHCBEAM1/IP-SDISP-QPBUMP, 1.0, 1.0
+on_qpbump.b2, LHCBEAM2/IP-SDISP-QPBUMP, 1.0, 1.0
 
 # IP angles (in separation plane)
 on_a1, LHCBEAM/IP1-ANGLE-H-MURAD, 1.0, 150.0
@@ -126,3 +133,11 @@ on_yip8b2, LHCBEAM2/IP8_SEPSCAN_Y_MM, 1.0, 1.0
 # Landau Octupoles
 on_mo.b1, LHCBEAM1/LANDAU_DAMPING, 1.0, 1.0
 on_mo.b2, LHCBEAM2/LANDAU_DAMPING, 1.0, 1.0
+
+# Phase Change
+phase_change.b1, LHCBEAM1/PHASECHANGE_2023_INJ, 1.0, 1.0
+phase_change.b2, LHCBEAM2/PHASECHANGE_2023_INJ, 1.0, 1.0
+
+# dp/p trim
+dp_trim.b1, LHCBEAM1/DP_TRIM_PERMIL, 1.0, 1.0
+dp_trim.b2, LHCBEAM2/DP_TRIM_PERMIL, 1.0, 1.0

tests/inputs/knob_extractor/state_2022-06-25.tfs

@@ -3,5 +3,5 @@
 $ %s                                     %s                   %s
   "Optics"             "R2022a_A30cmC30cmA10mL200cm"          "opticName"
   "Beam Process"       "SQUEEZE-6.8TeV-60cm-30cm_V1_FMD1@337_[END]"        "beamProcess"
-  "Optics ID"                      "6923.0"            "opticId"
+  "Optics ID"                        "6923"            "opticId"
   "HyperCycle"            "6.8TeV_2022_MD1"         "hyperCycle"