Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hat_reaction changing kmc type not intuitive #385

Open
emerbitz opened this issue Feb 23, 2024 · 4 comments
Open

hat_reaction changing kmc type not intuitive #385

emerbitz opened this issue Feb 23, 2024 · 4 comments

Comments

@emerbitz
Copy link

emerbitz commented Feb 23, 2024

From a user perspective it is confusing that the kmc type is changed by a reaction plugin. I think it should be a setting in the kimmdy config.yml, not of the individual plugins.
(written by Eric)

Any thought on this?

@KRiedmiller
Copy link
Collaborator

If I'm not mistaken, it is not 'changed' by the plugin, it is set in the first place by the plugin. If the user wants, he can overwrite the choice in the kimmdy.yml, either in the root of it or per plugin.

So, if you set the algorithm in the root of the config, this also should be used.
It is documented as "KMC algorithm overwrite. Should be set by the reactions, but can be changed here."

If this choice is not honored, I'd consider it a bug

@ehhartmann
Copy link
Collaborator

Effectively the plugin changes the behavior of the kimmdy run because decide_recipe is outside of the plugin. For Eddie this was unexpected behavior and I agree. The same applies for apply_recipe but I think this is closer related to the plugin than decide_recipe.
I would be fine with logging a info/warning in the plugin if the chosen kmc type is not optimal for the reaction but would prefer not to set the kmc type. The same behavior could be achieved by making the kmc type a required input in the config.yml without providing a default (to make the user think or at least see the kmc type). The kmc type is a major setting in a kimmdy run and should be more visible.

@ehhartmann
Copy link
Collaborator

Write whole config object to json in 0_setup?

@ehhartmann
Copy link
Collaborator

make plugin documentation accessible thorugh kimmdy documentation?

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

No branches or pull requests

3 participants