Feature: Add hardware_name and model_name to elements

[GamelinAl]

Description, motivation and use case
Both hardware_name and model_name need to be implemented.
This will allow to make the link between the different names in pyAML:

• name = pyAML unique identifier.
• hardware_name = control system name.
• model_name = lattice name.

Proposed solution
Add new properties to pyAML elements:

• hardware_name corresponding to the reference string in the control system.
• model_name corresponding to the element name in the lattice if any (model_name is not unique).

These properties are accessible in all control modes (live, design, ...).
The hardware_name is accessible if a control system has been defined in configuration.
The model_name is accessible if a simulator has been defined in configuration.

Example

Sextupole.name # returns 'SX.12.3'
Sextupole.hardware_name # returns 'AN01-AR/EM/SX.03'
Sextupole.model_name # returns 'SX.12'

[JeanLucPons]

OK for name and model_name.
However hardware_name can be a list of power supplies that does not necessarily share the same device name (3 fields).
When possible, hardware_name can reflect the corresponding power supply (or strength in case of identity_model) name otherwise a list will be returned.
Is it OK ?

[GamelinAl]

If I understand correctly you mean that hardware_name can return either a str or a list of str. That would be fine with me, I don't think we should use hardware_name internally but it's mostly to inform the user.

The only thing we should take care is that, the element access in ElementArray by hardware_name search inside these list (#41).

[JeanLucPons]

The only thing we should take care is that, the element access in ElementArray by hardware_name search inside these list (#41).

I don't see how to implement this.
Here is an example for 2 EBS horizontal correctors.

HCorrector(name='SH1A-C04-H', model='SH1A-C04', peer='Simulator:design', strength=0.000000, hardware_name=[srmag/ps-corr-sh1/c04-a-ch1/current, srmag/ps-corr-sh1/c04-a-ch2/current, srmag/ps-corr-sh1/c04-a-ch3/current, srmag/ps-corr-sh1/c04-a-ch5/current, srmag/ps-corr-sh1/c04-a-ch6/current])
HCorrector(name='SH1A-C05-H', model='SH1A-C05', peer='TangoControlSystem:live', strength=0.000001, hardware_name=[srmag/ps-corr-sh1/c05-a-ch1/current, srmag/ps-corr-sh1/c05-a-ch2/current, srmag/ps-corr-sh1/c05-a-ch3/current])

How do you expect that the selection works ?

[GamelinAl]

If these two elements are in an ElementArray, then I would expect that you could do something like:

array(hardware_name="srmag/ps-corr-sh1/c04*") # my ElementArray
# returns all Element which contains the matching string in hardware_name
# Here returns HCorrector(name='SH1A-C04-H', model='SH1A-C04', peer='Simulator:design', strength=0.000000, hardware_name=[srmag/ps-corr-sh1/c04-a-ch1/current, srmag/ps-corr-sh1/c04-a-ch2/current, srmag/ps-corr-sh1/c04-a-ch3/current, srmag/ps-corr-sh1/c04-a-ch5/current, srmag/ps-corr-sh1/c04-a-ch6/current])


array(hardware_name="srmag/ps-corr-sh1/c05-a-ch1/current") # my ElementArray
# returns  HCorrector(name='SH1A-C05-H', model='SH1A-C05', peer='TangoControlSystem:live', strength=0.000001, hardware_name=[srmag/ps-corr-sh1/c05-a-ch1/current, srmag/ps-corr-sh1/c05-a-ch2/current, srmag/ps-corr-sh1/c05-a-ch3/current])

array(hardware_name="srmag/ps-corr-sh1/c0*") # my ElementArray
# returns a subset of the inital ElementArray with both correctors.

Which corresponds to string matching with any of the fields inside the hardware_name property.

It can be useful if you want to access a pyAML object that you have the hardware name for. But I agree that this is only a convenience function, which may not be fully needed at that time. The same functionality with the name and model_name fields is more useful.

[JeanLucPons]

Ok for name and model_name.
May be i misunderstood something but you want to add a hardware_name property in the config to be be able to select on it.
In CATAP they have the concept of alias for this.
In the example you give, the power supplies are shared between other magnets sot it cannot returns what you expect,.

[JeanLucPons]

for instance:
manget(hardware_name="srmag/ps-corr-sh1/c04-a-ch1/current") will return an ElementArray:

HCorrector(peer='Simulator:design', name='SH1A-C04-H', model='SH1A-C04', magnet_model=LinearCFMagnetModel(multipoles=['B0', 'A0', 'A1', 'B2'], curves=[CSVCurve(file='sr/magnet_models/SHI_h_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_v_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sq_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sext_strength.csv')], calibration_factors=None, calibration_offsets=None, pseudo_factors=[1.0, -1.0, -1.0, -1.0], pseudo_offsets=None, powerconverters=[Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch1/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch2/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch3/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch5/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch6/current', unit='A')], matrix=CSVMatrix(file='sr/magnet_models/SHI_matrix.csv'), units=['rad', 'rad', 'm-1', 'm-2']))
VCorrector(peer='TangoControlSystem:live', name='SH1A-C04-V', model='SH1A-C04', magnet_model=LinearCFMagnetModel(multipoles=['B0', 'A0', 'A1', 'B2'], curves=[CSVCurve(file='sr/magnet_models/SHI_h_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_v_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sq_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sext_strength.csv')], calibration_factors=None, calibration_offsets=None, pseudo_factors=[1.0, -1.0, -1.0, -1.0], pseudo_offsets=None, powerconverters=[Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch1/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch2/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch3/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch5/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch6/current', unit='A')], matrix=CSVMatrix(file='sr/magnet_models/SHI_matrix.csv'), units=['rad', 'rad', 'm-1', 'm-2']))
SkewQuad(peer='TangoControlSystem:live', name='SH1A-C04-SQ', model='SH1A-C04', magnet_model=LinearCFMagnetModel(multipoles=['B0', 'A0', 'A1', 'B2'], curves=[CSVCurve(file='sr/magnet_models/SHI_h_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_v_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sq_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sext_strength.csv')], calibration_factors=None, calibration_offsets=None, pseudo_factors=[1.0, -1.0, -1.0, -1.0], pseudo_offsets=None, powerconverters=[Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch1/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch2/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch3/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch5/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch6/current', unit='A')], matrix=CSVMatrix(file='sr/magnet_models/SHI_matrix.csv'), units=['rad', 'rad', 'm-1', 'm-2']))
Sextupole(peer='TangoControlSystem:live', name='SH1A-C04-S', model='SH1A-C04', magnet_model=LinearCFMagnetModel(multipoles=['B0', 'A0', 'A1', 'B2'], curves=[CSVCurve(file='sr/magnet_models/SHI_h_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_v_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sq_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sext_strength.csv')], calibration_factors=None, calibration_offsets=None, pseudo_factors=[1.0, -1.0, -1.0, -1.0], pseudo_offsets=None, powerconverters=[Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch1/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch2/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch3/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch5/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch6/current', unit='A')], matrix=CSVMatrix(file='sr/magnet_models/SHI_matrix.csv'), units=['rad', 'rad', 'm-1', 'm-2']))
CombinedFunctionMagnet(peer='TangoControlSystem:live', name='SH1A-C04', mapping=[['B0', 'SH1A-C04-H'], ['A0', 'SH1A-C04-V'], ['A1', 'SH1A-C04-SQ'], ['B2', 'SH1A-C04-S']], model=LinearCFMagnetModel(multipoles=['B0', 'A0', 'A1', 'B2'], curves=[CSVCurve(file='sr/magnet_models/SHI_h_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_v_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sq_strength.csv'), CSVCurve(file='sr/magnet_models/SHI_sext_strength.csv')], calibration_factors=None, calibration_offsets=None, pseudo_factors=[1.0, -1.0, -1.0, -1.0], pseudo_offsets=None, powerconverters=[Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch1/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch2/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch3/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch5/current', unit='A'), Attribute(attribute='srmag/ps-corr-sh1/c04-a-ch6/current', unit='A')], matrix=CSVMatrix(file='sr/magnet_models/SHI_matrix.csv'), units=['rad', 'rad', 'm-1', 'm-2']))

It is what you expect ?

[JeanLucPons]

Here is a proposal runnable from the branch dynamic-elements-arrays .
Let me know if it is ok for you or if you have other ideas for the selection.

Here are few possible writing.

from pyaml.pyaml import pyaml,PyAML
from pyaml.configuration.factory import Factory
from pyaml.instrument import Instrument
from pyaml.arrays.element_array import ElementArray

ml:PyAML = pyaml("tests/config/EBSOrbit.yaml")
sr:Instrument = ml.get('sr')
ae = ElementArray("All",sr.design.get_all_elements())
acfm = ElementArray("AllCFM",sr.design.get_all_cfm_magnets(),use_aggregator=False)

bpmC5 = ae['BPM*'][10:20]
print(f"{type(bpmC5)}: {len(bpmC5)} items")  # All BPM C5
bpmc10 = ae['BPM*C10*'] # All BPM C10
print(f"{type(bpmc10)}: {len(bpmc10)} items")
magSHV = ae['SH*-V'] # All SH vertical corrector
print(f"{type(magSHV)}: {len(magSHV)} items")
magSH1A = ae['model_name:SH1A-*'] # All SH1A magnets (including the CFMs)
print(f"{type(magSH1A)}: {len(magSH1A)} items")
magSH1AC = acfm['model_name:SH1A-*'] # All SH1A magnets (CFMs only)
print(f"{type(magSH1AC)}: {len(magSH1AC)} items")
    
Factory.clear()

outputs

<class 'pyaml.arrays.bpm_array.BPMArray'>: 10 items
<class 'pyaml.arrays.bpm_array.BPMArray'>: 10 items
<class 'pyaml.arrays.magnet_array.MagnetArray'>: 96 items
<class 'pyaml.arrays.element_array.ElementArray'>: 129 items
<class 'pyaml.arrays.cfm_magnet_array.CombinedFunctionMagnetArray'>: 32 items

[gubaidulinvadim]

This issue was resolved by #60 (@JeanLucPons please correct if I am wrong)