Background: The keywords for solvers related to crystal growth simulations (HeatSovler, PhaseChangeSolver, StatMag, MgDyn2DHarmonic) were originally implemented in pyelmer, then moved to the submodule elmerkw. Currently, using these parameters is not the recommended workflow and importing elmerkw raises a DeprecationWarning. Instead, the user is encouraged to provide the keywords in a dictionary.
I think providing keywords is great advantage of pyelmer and gives a huge benefit to the users because they can rely on autocomplete functionality of their IDE instead of looking everything up in the manuals. It'd be great to bring back this functionality to the main elmer module but in a more structured manner helping the users to find the right keywords for their solvers. I am thinking of something like:
Background: The keywords for solvers related to crystal growth simulations (HeatSovler, PhaseChangeSolver, StatMag, MgDyn2DHarmonic) were originally implemented in pyelmer, then moved to the submodule elmerkw. Currently, using these parameters is not the recommended workflow and importing elmerkw raises a DeprecationWarning. Instead, the user is encouraged to provide the keywords in a dictionary.
I think providing keywords is great advantage of pyelmer and gives a huge benefit to the users because they can rely on autocomplete functionality of their IDE instead of looking everything up in the manuals. It'd be great to bring back this functionality to the main elmer module but in a more structured manner helping the users to find the right keywords for their solvers. I am thinking of something like: