OP knobs (#85)

Author: fsoubelet

.github/workflows/README.md

@@ -6,7 +6,7 @@ They are organised as follows.
 ### Documentation
 
 The `documentation` workflow triggers on any push to master, builds the documentation and pushes it to the `gh-pages` branch (if the build is successful).
-It runs on `ubuntu-latest` and the lowest supported Python version, `Python 3.7`.
+It runs on `ubuntu-latest` and `Python 3.9`.
 
 ### Testing Suite
 
@@ -16,7 +16,7 @@ Tests run on a matrix of all supported operating systems for all supported Pytho
 ### Test Coverage
 
 Test coverage is calculated in the `coverage` wokflow, which triggers on pushes to `master` and any push to a `pull request`.
-It runs on `ubuntu-latest` & the lowest supported Python version (`Python 3.7`), and reports the coverage results of the test suite to `Codecov`.
+It runs on `ubuntu-latest` and `Python 3.9`, and reports the coverage results of the test suite to `Codecov`.
 
 
 ### Regular Testing

.github/workflows/coverage.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:  # only lowest supported python on ubuntu-latest
         os: [ubuntu-latest]
-        python-version: [3.7]
+        python-version: [3.9]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/cron.yml

@@ -15,8 +15,13 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-latest, windows-latest]
-        python-version: [3.7, 3.8, 3.9, 3.x]  # crons should always run latest python hence 3.x
+        os: [ubuntu-18.04, ubuntu-20.04, ubuntu-22.04, macos-latest, windows-latest]
+        python-version: [3.7, 3.8, 3.9, "3.10", 3.x]  # crons should always run latest python hence 3.x
+        exclude:
+          - os: windows-latest
+            python-version: "3.10"
+          - os: windows-latest
+            python-version: "3.x"
       fail-fast: false
 
     steps:

.github/workflows/documentation.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:  # only lowest supported python on ubuntu-latest
         os: [ubuntu-latest]
-        python-version: [3.7]
+        python-version: [3.9]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/publish.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:  # only lowest supported python on ubuntu-latest
         os: [ubuntu-latest]
-        python-version: [3.7]
+        python-version: [3.9]
 
 
     steps:

.github/workflows/tests.yml

@@ -15,8 +15,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, ubuntu-20.04, macos-latest, windows-latest]
+        os: [ubuntu-18.04, ubuntu-20.04, ubuntu-22.04, macos-latest, windows-latest]
         python-version: [3.7, 3.8, 3.9]
+        exclude:
+          - os: windows-latest
+            python-version: "3.10"
       fail-fast: false
 
     steps:

docs/release.rst

@@ -3,6 +3,21 @@ Release Notes
 
 The full list of releases can be found in the Github repository's `releases page <https://github.com/fsoubelet/PyhDToolkit/releases>`_.
 
+.. _release_0.19.1:
+
+0.19.1
+------
+
+Maintenance
+~~~~~~~~~~~
+
+* The `~pyhdtoolkit.cpymadtools.lhc.get_lhc_tune_and_chroma_knobs` function now can has a new boolean argument, `run3`, to determine if the standard `_op` knobs should be returned.
+* The functions in the `~pyhdtoolkit.cpymadtools.matching` module now also have the `run3` argument, and will call the Run 3 `_op` knobs if this argument is set to `True` and the `LHC` accelerator is passed.
+* Fixes have been provided to the various Github Actions workflow of the repository.
+
+See `v0.19.1 release notes on GitHub <https://github.com/fsoubelet/PyhDToolkit/releases/tag/0.19.1>`_ and the `full changes since v0.18.0 <https://github.com/fsoubelet/PyhDToolkit/compare/0.19.0...0.19.1>`_.
+
+
 .. _release_0.19.0:
 
 0.19.0

pyhdtoolkit/cpymadtools/lhc.py

@@ -669,7 +669,7 @@ def get_lhc_bpms_list(madx: Madx) -> List[str]:
 
 
 def get_lhc_tune_and_chroma_knobs(
-    accelerator: str, beam: int = 1, telescopic_squeeze: bool = True
+    accelerator: str, beam: int = 1, telescopic_squeeze: bool = True, run3: bool = False
 ) -> Tuple[str, str, str, str]:
     """
     Gets names of knobs needed to match tunes and chromaticities as a tuple of strings,
@@ -682,6 +682,7 @@ def get_lhc_tune_and_chroma_knobs(
         beam (int): Beam to use, for the knob names. Defaults to 1.
         telescopic_squeeze (bool): if set to `True`, returns the knobs for Telescopic
             Squeeze configuration. Defaults to `True` to reflect run III scenarios.
+        run3 (bool): if set to `True`, returns the Run 3 `*_op` knobs.
 
     Returns:
         A `tuple` of strings with knobs for ``(qx, qy, dqx, dqy)``.
@@ -698,7 +699,12 @@ def get_lhc_tune_and_chroma_knobs(
             ('kqtf.b2_sq', 'kqtd.b2_sq', 'ksf.b2_sq', 'ksd.b2_sq')
     """
     beam = 2 if beam == 4 else beam
-    suffix = "_sq" if telescopic_squeeze else ""
+    if run3:
+        suffix = "_op"
+    elif telescopic_squeeze:
+        suffix = "_sq"
+    else:
+        suffix = ""
 
     if accelerator.upper() not in ("LHC", "HLLHC"):
         logger.error("Invalid accelerator name, only 'LHC' and 'HLLHC' implemented")

pyhdtoolkit/cpymadtools/matching.py

@@ -29,6 +29,7 @@ def match_tunes_and_chromaticities(
     dq2_target: float = None,
     varied_knobs: Sequence[str] = None,
     telescopic_squeeze: bool = True,
+    run3: bool = False,
     step: float = 1e-7,
     calls: int = 100,
     tolerance: float = 1e-21,
@@ -81,7 +82,8 @@ def match_tunes_and_chromaticities(
             could be ``["kqf", "ksd", "kqf", "kqd"]`` as they are common names used for quadrupole and sextupole
             strengths (focusing / defocusing) in most examples.
         telescopic_squeeze (bool): ``LHC`` specific. If set to `True`, uses the ``(HL)LHC`` knobs for Telescopic
-            Squeeze configuration. Defaults to `True` as of run III.
+            Squeeze configuration. Defaults to `True` since `v0.9.0`.
+        run3 (bool): if set to `True`, uses the `LHC` Run 3 `*_op` knobs. Defaults to `False`.
         step (float): step size to use when varying knobs.
         calls (int): max number of varying calls to perform.
         tolerance (float): tolerance for successfull matching.
@@ -120,7 +122,7 @@ def match_tunes_and_chromaticities(
     if accelerator and not varied_knobs:
         logger.trace(f"Getting knobs from default {accelerator.upper()} values")
         lhc_knobs = get_lhc_tune_and_chroma_knobs(
-            accelerator=accelerator, beam=int(sequence[-1]), telescopic_squeeze=telescopic_squeeze
+            accelerator=accelerator, beam=int(sequence[-1]), telescopic_squeeze=telescopic_squeeze, run3=run3
         )
         tune_knobs, chroma_knobs = lhc_knobs[:2], lhc_knobs[2:]  # first two, last two
 
@@ -171,6 +173,7 @@ def match_tunes(
     q2_target: float = None,
     varied_knobs: Sequence[str] = None,
     telescopic_squeeze: bool = True,
+    run3: bool = False,
     step: float = 1e-7,
     calls: int = 100,
     tolerance: float = 1e-21,
@@ -195,7 +198,8 @@ def match_tunes(
         q2_target (float): vertical tune to match to.
         varied_knobs (Sequence[str]): the variables names to ``VARY`` in the ``MAD-X`` ``MATCH`` routine.
         telescopic_squeeze (bool): ``LHC`` specific. If set to `True`, uses the ``(HL)LHC`` knobs for Telescopic
-            Squeeze configuration. Defaults to `True` as of run III.
+            Squeeze configuration. Defaults to `True` since `v0.9.0`.
+        run3 (bool): if set to `True`, uses the `LHC` Run 3 `*_op` knobs. Defaults to `False`.
         step (float): step size to use when varying knobs. Defaults to `1E-7`.
         calls (int): max number of varying calls to perform. Defaults to `100`.
         tolerance (float): tolerance for successfull matching. Defaults to `1E-21`.
@@ -236,6 +240,7 @@ def match_tunes(
         dq2_target=None,
         varied_knobs=varied_knobs,
         telescopic_squeeze=telescopic_squeeze,
+        run3=run3,
         step=step,
         calls=calls,
         tolerance=tolerance,
@@ -250,6 +255,7 @@ def match_chromaticities(
     dq2_target: float = None,
     varied_knobs: Sequence[str] = None,
     telescopic_squeeze: bool = True,
+    run3: bool = False,
     step: float = 1e-7,
     calls: int = 100,
     tolerance: float = 1e-21,
@@ -274,7 +280,8 @@ def match_chromaticities(
         q2_target (float): vertical tune to match to.
         varied_knobs (Sequence[str]): the variables names to ``VARY`` in the ``MAD-X`` ``MATCH`` routine.
         telescopic_squeeze (bool): ``LHC`` specific. If set to `True`, uses the ``(HL)LHC`` knobs for Telescopic
-            Squeeze configuration. Defaults to `True` as of run III.
+            Squeeze configuration. Defaults to `True` since `v0.9.0`.
+        run3 (bool): if set to `True`, uses the `LHC` Run 3 `*_op` knobs. Defaults to `False`.
         step (float): step size to use when varying knobs. Defaults to `1E-7`.
         calls (int): max number of varying calls to perform. Defaults to `100`.
         tolerance (float): tolerance for successfull matching. Defaults to `1E-21`.
@@ -315,6 +322,7 @@ def match_chromaticities(
         dq2_target=dq2_target,
         varied_knobs=varied_knobs,
         telescopic_squeeze=telescopic_squeeze,
+        run3=run3,
         step=step,
         calls=calls,
         tolerance=tolerance,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyhdtoolkit"
-version = "0.19.0"
+version = "0.19.1"
 description = "An all-in-one toolkit package to ease my Python work in my PhD."
 authors = ["Felix Soubelet <[email protected]>"]
 license = "MIT"

tests/test_cpymadtools/test_lhc.py

@@ -281,10 +281,16 @@ def test_vary_independent_ir_quads_raises_on_wrong_quads(self, _non_matched_lhc_
 
     @pytest.mark.parametrize("beam", [1, 2, 3, 4])
     @pytest.mark.parametrize("telescopic_squeeze", [False, True])
-    def test_lhc_tune_and_chroma_knobs(self, beam, telescopic_squeeze):
+    @pytest.mark.parametrize("run3", [False, True])
+    def test_lhc_tune_and_chroma_knobs(self, beam, telescopic_squeeze, run3):
         expected_beam = 2 if beam == 4 else beam
-        expected_suffix = "_sq" if telescopic_squeeze else ""
-        assert get_lhc_tune_and_chroma_knobs("LHC", beam, telescopic_squeeze) == (
+        if run3:
+            expected_suffix = "_op"
+        elif telescopic_squeeze:
+            expected_suffix = "_sq"
+        else:
+            expected_suffix = ""
+        assert get_lhc_tune_and_chroma_knobs("LHC", beam, telescopic_squeeze, run3) == (
             f"dQx.b{expected_beam}{expected_suffix}",
             f"dQy.b{expected_beam}{expected_suffix}",
             f"dQpx.b{expected_beam}{expected_suffix}",