Live/Design: control modes#
With pyAML it is possible to use the same commands either:
live: on the real accelerator
design: in simulations
errors: in simulations with errors (and for several seeds)
live (with a different prefix/host): in a virtual control system (same as in point 1. for those laboratories that have a simulated control system)
Those are called “control modes” and may be used
at a global script level (for testing in simulations and then using in real accelerator measurements with a simple switch/comment)
anywhere in the script
Using pyAML on a real accelerator
import os
import numpy as np
from pyaml.accelerator import Accelerator
instantiate a pyAML accelerator
SR: Accelerator = Accelerator.load("../../tests/config/EBSTune.yaml")
---------------------------------------------------------------------------
PyAMLConfigException Traceback (most recent call last)
Cell In[2], line 1
----> 1 SR: Accelerator = Accelerator.load("../../tests/config/EBSTune.yaml")
File ~/checkouts/readthedocs.org/user_builds/pyaml/envs/stable/lib/python3.13/site-packages/pyaml/accelerator.py:304, in Accelerator.load(filename, use_fast_loader, ignore_external)
299 except UnsupportedConfigurationRootError as ex:
300 raise PyAMLConfigException(
301 "Accelerator.load() expects a 'pyaml.accelerator' root configuration. "
302 "Use the factory APIs to build sub-elements directly."
303 ) from ex
--> 304 return manager.build(ignore_external=ignore_external)
File ~/checkouts/readthedocs.org/user_builds/pyaml/envs/stable/lib/python3.13/site-packages/pyaml/configuration/manager.py:496, in ConfigurationManager.build(self, ignore_external)
494 set_root_folder(self._build_root)
495 snapshot = ConfigurationManager.strip_runtime_internal_metadata(self._snapshot(include_internal_metadata=True))
--> 496 return Accelerator.from_dict(snapshot, ignore_external=ignore_external)
File ~/checkouts/readthedocs.org/user_builds/pyaml/envs/stable/lib/python3.13/site-packages/pyaml/accelerator.py:275, in Accelerator.from_dict(config_dict, ignore_external)
273 # Ensure factory is clean before building a new accelerator
274 Factory.clear()
--> 275 return Factory.depth_first_build(config_dict, ignore_external)
File ~/checkouts/readthedocs.org/user_builds/pyaml/envs/stable/lib/python3.13/site-packages/pyaml/configuration/factory.py:194, in PyAMLFactory.depth_first_build(self, d, ignore_external)
191 # Do not recurse dict defined in ConfigModel
192 # pydantic use TypedDict not usable with isinstance
193 if str(fieldType) != "<class 'dict'>":
--> 194 obj = self.depth_first_build(value, ignore_external)
195 # Replace the inner dict by the object itself
196 d[key] = obj
File ~/checkouts/readthedocs.org/user_builds/pyaml/envs/stable/lib/python3.13/site-packages/pyaml/configuration/factory.py:177, in PyAMLFactory.depth_first_build(self, d, ignore_external)
175 for _index, e in enumerate(d):
176 if isinstance(e, dict) or isinstance(e, list):
--> 177 obj = self.depth_first_build(e, ignore_external)
178 l.append(obj)
179 else:
File ~/checkouts/readthedocs.org/user_builds/pyaml/envs/stable/lib/python3.13/site-packages/pyaml/configuration/factory.py:184, in PyAMLFactory.depth_first_build(self, d, ignore_external)
181 return l
183 elif isinstance(d, dict):
--> 184 _, config_cls, *_ = self.get_infos(d, ignore_external)
186 for key, value in d.items():
187 if not key == "__fieldlocations__":
File ~/checkouts/readthedocs.org/user_builds/pyaml/envs/stable/lib/python3.13/site-packages/pyaml/configuration/factory.py:84, in PyAMLFactory.get_infos(self, d, ignore_external)
81 except ModuleNotFoundError as ex:
82 if not ignore_external:
83 # Discard module not found stack trace
---> 84 raise PyAMLConfigException(
85 "Module referenced in type cannot be found:" + f"'{module_str}' {location_str}"
86 ) from None
87 else:
88 return None
PyAMLConfigException: Module referenced in type cannot be found:'tango.pyaml.controlsystem' /home/docs/checkouts/readthedocs.org/user_builds/pyaml/checkouts/stable/tests/config/EBSTune.yaml at line 12, column 5.
Switch between live and design
Access some magnet families defined in the configuration is simple. One can use sr.live for live control system or sr.design for the simulator part. They provide identical interface.
sr = SR.design # simulations
# sr = SR.live # act on real accelerator
---------------------------------------------------------------------------
NameError Traceback (most recent call last)
Cell In[3], line 1
----> 1 sr = SR.design # simulations
2 # sr = SR.live # act on real accelerator
NameError: name 'SR' is not defined
quadForTune = sr.get_magnets("QForTune")
tune_device = sr.get_betatron_tune_monitor("BETATRON_TUNE")
---------------------------------------------------------------------------
NameError Traceback (most recent call last)
Cell In[4], line 1
----> 1 quadForTune = sr.get_magnets("QForTune")
2
3 tune_device = sr.get_betatron_tune_monitor("BETATRON_TUNE")
NameError: name 'sr' is not defined
For example a tune response matrix is evaluated below. This script is used identically for computation of theoretical values or to measure the response directly on the accelerator.
# Build tune response matrix
initial_tune = tune_device.tune.get()
print(f"Tune via pyAML interface for design mode {initial_tune}")
tunemat = np.zeros((len(quadForTune), 2))
for idx, m in enumerate(quadForTune):
str = m.strength.get()
m.strength.set(str + 1e-4)
dq = tune_device.tune.get() - initial_tune
tunemat[idx] = dq * 1e4
m.strength.set(str)
---------------------------------------------------------------------------
NameError Traceback (most recent call last)
Cell In[5], line 2
1 # Build tune response matrix
----> 2 initial_tune = tune_device.tune.get()
3 print(f"Tune via pyAML interface for design mode {initial_tune}")
4 tunemat = np.zeros((len(quadForTune), 2))
5
NameError: name 'tune_device' is not defined
At any point in the code it is always possible to still access any of the control modes
SR.design.get_lattice().disable_6d()
tune_design = SR.design.get_lattice().get_tune()
print(f"Tune directly from the lattice {tune_design}")
---------------------------------------------------------------------------
NameError Traceback (most recent call last)
Cell In[6], line 1
----> 1 SR.design.get_lattice().disable_6d()
2 tune_design = SR.design.get_lattice().get_tune()
3
4 print(f"Tune directly from the lattice {tune_design}")
NameError: name 'SR' is not defined