Skip to content

Modify the config files to be able to run the examples - #10

Merged
GamelinAl merged 1 commit into
mainfrom
fix-config-examples
Sep 15, 2026
Merged

GamelinAl merged 1 commit into
mainfrom
fix-config-examples

Conversation

@GamelinAl

Copy link
Copy Markdown
Member

This MR try to solve #7

I did some configuration changes that should be ok pour pyaml in design mode.
I did some other checks with the live mode and dt4acc and it seems to work also.

Probably this will need further changes in the future but for now this should work.

@gubaidulinvadim gubaidulinvadim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I see this is a bit more than defining arrays and tuning tools. There were BPMS and Corrector magnets missing in the test lattice config files. Looks good! I have a question on .description files. I do not understand what is this.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the .description files?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the README.md

Optional descriptions can be added without changing the registry. Place a
file named <filename>.description next to any lattice or
configuration file. Its text is displayed when printing the registry:

fodo_1gev_6d.json.description

To list the available files and their description, print a registry:

print(configurations)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are to provide a description to explain what the different files are when you use the functionality of the package to list available configurations to choose from. If there is no .description file there will just be no description printed so they are not mandatory.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like in this tutorial: https://python-accelerator-middle-layer.github.io/documentation/tutorials/01_create_accelerator.html#prerequisites

The descriptions of the file in that output come from the .description files.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand the need for it but as long as this is optional I do not care.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just to provide the users with some quick info about which file to load depending on what they want to test. For example, which config file to use if they want to try the tango-pyaml vs the pyaml-cs-oa tango bindings.

@gubaidulinvadim
gubaidulinvadim self-requested a review September 15, 2026 12:03
@TeresiaOlsson

Copy link
Copy Markdown
Member

Thank you so much @GamelinAl :) I will try making the examples into tutorials again this evening. If there is some new problem I think I should be able to figure out how to fix it myself with this start.

@GamelinAl
GamelinAl merged commit 20a0602 into main Sep 15, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants