nemocrys / pyelmer

A python interface to Elmer.
GNU General Public License v3.0
53 stars 15 forks source link

Simplification of pyelmer #6

Closed arvedes closed 1 year ago

arvedes commented 3 years ago

We (Kaspars & Arved) want to simplify pyelmer a bit to make it easier to maintain, as discussed here #4 . For this, solver-specific key words shall be adjusted in three steps:

  1. change the examples to lead new users to use the data-dictionary
  2. re-implement the keywords elsewhere in a derived class, e.g. class BoundaryWithKeywords(Boundary)
  3. remove the keywords from main module elmer.py

To encourage new users to use their own settings (referring to #5), the data directory shall be moved to the examples directory and not be distributed with the package anymore. This change is also motivated by the fact that it is impossible to provide universal default settings for a solver, simulation, etc. The interface for working with these files may be adapted a bit in consideration of #3.

Eventually, we want to move the gmsh module to another project. It fits well into the pyelmer workflow, but does not contribute to its key functionality. I'm not sure what the result will look like, but I am confident that these changes are possible without affecting the user interface (by introducing the new project as dependency).

I hope that we can make a v1.0.0 release once all this is completed!

I'll continue with all this after my summer holiday, but I'd be happy to get some feedback until then!

arvedes commented 1 year ago

this was implemented with v1.0.0