Feature: Universal Examples

[simoneliuzzo]

Description, motivation and use case
@kparasch, @GamelinAl, Ivan Morozov, Julien Gethmann

config files of examples should be in the specific example folder

one single example for Tune, ORM, etc.. and several config files (minimal) to show the same example works for many machines.

[gubaidulinvadim]

@simoneliuzzo, aren't all examples universal? All I had to do for SOLEIL examples was to modify the ones from BESSY and ESRF. I'm currently working on updating the SOLEIL examples. If you want to we can merge with ESRF / BESSY examples. It is just a config file swap, if everything is defined in the config. The only friction point is that we do not have (yet) a universal digital twin.

[GamelinAl]

@gubaidulinvadim what we discussed during the workshop is that we should have two types of examples.

I will expand a bit and propose some organization based on the very good resource https://diataxis.fr/

• How-to guide (or minimum working example) describing a specific feature of pyAML (i.e. Tune, ORM, ...)
  • In this type of example, we would like the code to be facility independent.
  • We could go for a folder structure with one folder per feature.
  • Inside the folder, we have different configuration files for the different machines and the script to test the feature.
  • The configuration should be the minimum possible to do this specific measurement.
  • In the test script, it is possible to change one line (loading the configuration) to run the test on another machine.
• In depth tutorial presenting pyAML feature more globally
  • In the tutorials, the aim is to demonstrate some features of pyAML and make the user learn
  • In this kind of tutorial it is allowed to refer to a given magnet family, for example, so it is machine specific.

[simoneliuzzo]

they are not organized to show their universality.
For example there are 3 tune scripts. While one should be sufficient, with the option to chose 3 different accelerators and switch from live to design to errros control modes