Orbit correction and Orbit Response Matrix measurement through pySC.

.github/workflows/tests.yml

@@ -26,10 +26,13 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        git submodule update --init --recursive
         pip install numpy
         pip install scipy
         pip install pydantic
         pip install accelerator-toolbox
+        pip install matplotlib
+        pip install h5py
         pip install pyaml
         pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "pyaml/external/pySC"]
+	path = pyaml/external/pySC
+	url = https://github.com/kparasch/pySC.git

examples/ESRF_ORM_example/correct_orbit.py

@@ -0,0 +1,92 @@
+import json
+import logging
+from pathlib import Path
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+from pyaml.accelerator import Accelerator
+from pyaml.tuning_tools.orbit import ConfigModel as Orbit_ConfigModel
+from pyaml.tuning_tools.orbit import Orbit
+
+parent_folder = Path(__file__).parent
+pyaml_folder = parent_folder.parent.parent
+config_path = pyaml_folder.joinpath("tests/config/EBSOrbit.yaml").resolve()
+sr = Accelerator.load(config_path)
+ebs = sr.design
+
+orbit = Orbit(
+    element_holder=ebs,
+    cfg=Orbit_ConfigModel(
+        bpm_array_name="BPM",
+        hcorr_array_name="HCorr",
+        vcorr_array_name="VCorr",
+        singular_values=162,
+        response_matrix_file=str(
+            pyaml_folder.joinpath("examples/ESRF_ORM_example/ideal_orm.json").resolve()
+        ),
+    ),
+)
+
+## get reference
+ref_h, ref_v = orbit.element_holder.get_bpms("BPM").positions.get().T
+reference = np.concat((ref_h, ref_v))
+########################################################
+
+
+## generate some orbit
+std_kick = 1e-6
+hcorr = ebs.get_magnets("HCorr")
+vcorr = ebs.get_magnets("VCorr")
+bpms = ebs.get_bpms("BPM")
+
+# mangle orbit
+hcorr.strengths.set(
+    hcorr.strengths.get() + std_kick * np.random.normal(size=len(hcorr))
+)
+vcorr.strengths.set(
+    vcorr.strengths.get() + std_kick * np.random.normal(size=len(vcorr))
+)
+
+positions_bc = bpms.positions.get()
+std_bc = np.std(positions_bc, axis=0)
+print(
+    "R.m.s. orbit before correction "
+    f"H: {1e6 * std_bc[0]: .1f} µm, V: {1e6 * std_bc[1]: .1f} µm."
+)
+########################################################
+
+## Correct the orbit
+orbit.correct(reference=reference)
+# orbit.correct(plane="H")
+# orbit.correct(plane="V")
+########################################################
+
+## inspect orbit correction
+positions_ac = bpms.positions.get()
+std_ac = np.std(positions_ac, axis=0)
+print(
+    "R.m.s. orbit after correction H: "
+    f"{1e6 * std_ac[0]: .1f} µm, V: {1e6 * std_ac[1]: .1f} µm,"
+)
+
+fig = plt.figure()
+ax1 = fig.add_subplot(311)
+ax2 = fig.add_subplot(312)
+ax3 = fig.add_subplot(313)
+ax1.plot(positions_bc[:, 0] * 1e6, label="Orbit before correction")
+ax2.plot(positions_bc[:, 1] * 1e6, label="Orbit before correction")
+ax1.plot(positions_ac[:, 0] * 1e6, label="Orbit after correction")
+ax2.plot(positions_ac[:, 1] * 1e6, label="Orbit after correction")
+
+ax3.plot(hcorr.strengths.get())
+ax3.plot(vcorr.strengths.get())
+
+ax1.set_ylabel("Horizontal pos. [μm]")
+ax2.set_ylabel("Vertical pos. [μm]")
+ax2.set_xlabel("BPM number")
+ax3.set_ylabel("Strength (rad)")
+ax3.set_xlabel("Steerer number")
+fig.tight_layout()
+
+plt.show()

examples/ESRF_ORM_example/esrf_orm_example.py

@@ -0,0 +1,32 @@
+from pathlib import Path
+
+import numpy as np
+
+from pyaml.accelerator import Accelerator
+from pyaml.external.pySC_interface import pySCInterface
+
+config_path = (
+    Path(__file__)
+    .parent.parent.parent.joinpath("tests", "config", "EBSOrbit.yaml")
+    .resolve()
+)
+sr = Accelerator.load(config_path)
+
+live_h = sr.live.get_bpms("BPM").h.get()  # ok
+design_h = sr.design.get_bpms("BPM").h.get()  # ok
+
+interface = pySCInterface(element_holder=sr.design)
+
+orbit_x, orbit_y = interface.get_orbit()
+
+one_hcorr = interface.hcorr_names[10]
+
+sp0 = interface.get(one_hcorr)
+interface.set(one_hcorr, sp0 + 10e-6)
+
+hcorr_setpoints = interface.get_many(interface.hcorr_names)
+interface.set_many(hcorr_setpoints)
+
+orbit_x2, orbit_y2 = interface.get_orbit()
+
+print(np.std(orbit_x2 - orbit_x))

examples/ESRF_ORM_example/measure_dispersion.py

@@ -0,0 +1,31 @@
+from pathlib import Path
+
+import matplotlib.pyplot as plt
+
+from pyaml.accelerator import Accelerator
+from pyaml.tuning_tools.dispersion import ConfigModel as Disp_ConfigModel
+from pyaml.tuning_tools.dispersion import Dispersion
+
+parent_folder = Path(__file__).parent
+config_path = parent_folder.parent.parent.joinpath(
+    "tests", "config", "EBSOrbit.yaml"
+).resolve()
+sr = Accelerator.load(config_path)
+element_holder = sr.design
+
+dispersion = Dispersion(
+    cfg=Disp_ConfigModel(
+        bpm_array_name="BPM",
+        rf_plant_name="RF",
+        frequency_delta=10,
+    ),
+    element_holder=element_holder,
+)
+
+dispersion.measure()
+dispersion_data = dispersion.get()
+
+fig = plt.figure()
+ax = fig.add_subplot(111)
+ax.plot(dispersion_data["frequency_response_x"])
+plt.show()

examples/ESRF_ORM_example/measure_ideal_ORM.py

@@ -0,0 +1,29 @@
+from pathlib import Path
+
+from pyaml.accelerator import Accelerator
+from pyaml.tuning_tools.orbit_response_matrix import ConfigModel as ORM_ConfigModel
+from pyaml.tuning_tools.orbit_response_matrix import OrbitResponseMatrix
+
+parent_folder = Path(__file__).parent
+config_path = parent_folder.parent.parent.joinpath(
+    "tests", "config", "EBSOrbit.yaml"
+).resolve()
+sr = Accelerator.load(config_path)
+element_holder = sr.design
+
+orm = OrbitResponseMatrix(
+    cfg=ORM_ConfigModel(
+        bpm_array_name="BPM",
+        hcorr_array_name="HCorr",
+        vcorr_array_name="VCorr",
+        corrector_delta=1e-6,
+    ),
+    element_holder=element_holder,
+)
+
+orm.measure()
+orm.save(parent_folder / Path("ideal_orm.json"))
+orm.save(parent_folder / Path("ideal_orm.yaml"), with_type="yaml")
+orm.save(parent_folder / Path("ideal_orm.npz"), with_type="npz")
+
+ormdata = orm.get()

examples/ESRF_ORM_example/measure_ideal_ORM_and_disp.py

@@ -0,0 +1,55 @@
+import json
+from pathlib import Path
+
+import numpy as np
+
+from pyaml.accelerator import Accelerator
+from pyaml.tuning_tools.dispersion import ConfigModel as Disp_ConfigModel
+from pyaml.tuning_tools.dispersion import Dispersion
+from pyaml.tuning_tools.orbit_response_matrix import ConfigModel as ORM_ConfigModel
+from pyaml.tuning_tools.orbit_response_matrix import OrbitResponseMatrix
+
+parent_folder = Path(__file__).parent
+config_path = parent_folder.parent.parent.joinpath(
+    "tests", "config", "EBSOrbit.yaml"
+).resolve()
+sr = Accelerator.load(config_path)
+element_holder = sr.design
+
+orm = OrbitResponseMatrix(
+    cfg=ORM_ConfigModel(
+        bpm_array_name="BPM",
+        hcorr_array_name="HCorr",
+        vcorr_array_name="VCorr",
+        corrector_delta=1e-6,
+    ),
+    element_holder=element_holder,
+)
+
+orm.measure()
+
+orm_data = orm.get()
+
+dispersion = Dispersion(
+    cfg=Disp_ConfigModel(
+        bpm_array_name="BPM",
+        rf_plant_name="RF",
+        frequency_delta=10,
+    ),
+    element_holder=element_holder,
+)
+
+dispersion.measure()
+dispersion_data = dispersion.get()
+rf_response = (
+    dispersion_data["frequency_response_x"] + dispersion_data["frequency_response_y"]
+)
+
+ideal_ORM_data = {
+    "matrix": orm_data["matrix"],
+    "input_names": orm_data["input_names"],
+    "output_names": orm_data["output_names"],
+    "rf_response": rf_response,
+}
+
+json.dump(ideal_ORM_data, open("ideal_orm_disp.json", "w"), indent=4)

examples/ESRF_ORM_example/measure_reduced_ORM.py

@@ -0,0 +1,38 @@
+from pathlib import Path
+
+from pyaml.accelerator import Accelerator
+from pyaml.tuning_tools.orbit_response_matrix import ConfigModel as ORM_ConfigModel
+from pyaml.tuning_tools.orbit_response_matrix import OrbitResponseMatrix
+
+parent_folder = Path(__file__).parent
+config_path = parent_folder.parent.parent.joinpath(
+    "tests", "config", "EBSOrbit.yaml"
+).resolve()
+sr = Accelerator.load(config_path)
+element_holder = sr.design
+
+orm = OrbitResponseMatrix(
+    cfg=ORM_ConfigModel(
+        bpm_array_name="BPM",
+        hcorr_array_name="HCorr",
+        vcorr_array_name="VCorr",
+        corrector_delta=1e-6,
+    ),
+    element_holder=element_holder,
+)
+
+hcorr = element_holder.get_magnets("HCorr")
+vcorr = element_holder.get_magnets("VCorr")
+corrector_names = (
+    hcorr["SJ2A*"].names()
+    + hcorr["SF2A*"].names()
+    + hcorr["SI2A*"].names()
+    + vcorr["SJ2A*"].names()
+    + vcorr["SF2A*"].names()
+    + vcorr["SI2A*"].names()
+)
+
+orm.measure(corrector_names=corrector_names)
+orm.save(parent_folder / Path("reduced_orm.json"))
+
+ormdata = orm.get()