search

RuruX / shell_analysis_fenicsx

GNU Lesser General Public License v3.0
11 stars 2 forks source link

Change lowercase 'x' to uppercase 'X' for consistency with directory name so that installation succeeds #2

Closed austinherrema closed 2 years ago

austinherrema commented 2 years ago

Fix as suggested in issue #1

RuruX commented 2 years ago

Thank you for spotting this bug! Actually, it's an open question to me that whether we should go with shell_analysis_fenicsx or shell_analysis_fenicsX. The reason we chose to use the latter before is to distinguish it with shell_analysis_fenics, the same shell solver implemented with the legacy FEniCS, which has been removed a while ago, so we probably no longer need the uppercase X anymore. Instead, lowercase x seems to suit it better for the naming convention of Python modules. And the only disadvantage, as you said, is to modify the module imports in the examples consistently. And since we don't have a lot of users yet, I think it won't be too bad to do it now. What do you think?

austinherrema commented 2 years ago

Ah, good point that python modules tend to be all lowercase! No strong preference from my side--as you say, the user base is small and it should be relatively straightforward to make the change either way. If you would prefer lowercase x then you should obviously feel free to do so!

RuruX commented 2 years ago

Changed the uppercase X to be lowercase x in the module name and examples as shell_analysis_fenicsx in commit 595d3b05e6ee198b639bed9958e69871d2603f35.