Configuration example with several files

[gubaidulinvadim]

Description, motivation and use case
This is based on the feedback of Working Group 3 (@TeresiaOlsson @lnadolski @patrickmadela @gayane960 https://github.com/orgs/python-accelerator-middle-layer/discussions/44)

• A long yaml file is not easy to use. In the examples there is also data which is repeated in several files which makes it difficult to maintain and keep in sync. It would be better to separate the config in several files.
  

• At the moment different parts of the configuration is mixed in the same file. For example, device information which doesn't change often is in the same file as measurement settings which might change more often.
  

• We also need a good option to handle configuration for different optional modes. This is not only different optics but some labs also use this feature for different operational runs during the year.
  

• We need a way for applications to update when the configuration is changed so all parts are kept in sync.
  

• We also would like to have some functionality to browse and modify the configuration after it has been loaded.
  

• The yaml file is difficult to generate and modify for new users. It would be nice with a utility GUI which helps you to visualise and change the yaml file without having to do it directly in the file.
  

Proposed solution

Create an example of configuration that

• Uses several files
• Each file contains different part of the config (e.g. device config, tuning tools config, etc)
• Example of config of two different operation modes that can reuse some common config

Additional context
Partially related to #187

Checklist

• I've assigned this issue to a project
• I've @-mentioned relevant people

[TeresiaOlsson]

I have on my to do list (but don't know when I ever will have time to do it...) to try hydra which as far as I have understood is a package to do exactly this to understand if it might simplify things for us compared to implementing and maintaining this functionality ourselves.

[gubaidulinvadim]

I think this is already possible to split one yaml file to several. I think, it's only a question of writing an example.

[TeresiaOlsson]

I know but if I remember correctly it was implemented in a way which would make it difficult to use a json schema to get help writing the yaml file. My hope was that by looking of how hydra does is that problem could be solved.

[JeanLucPons]

You have some examples in tests.
by default yaml or json are expanded unless they are prefixed by "file:"
So no issue to use a json file that is not interpreted as a link an expanded. (we use this in ORM already).
Ex: sr.yaml

devices:
  - sr/quadrupoles/QF1AC01.yaml
  - sr/correctors/SH1AC01.yaml
  - sr/correctors/SH1AC02.yaml

[JeanLucPons]

However I'm not sure but I think there is still an issue with absolute path. To be checked.