Fitting preparation #8
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| if TYPE_CHECKING: | ||
| from easyscience.Fitting.Fitting import Fitter | ||
| from easyscience.Fitting import Fitter |
There was a problem hiding this comment.
Only update to import path. Other changes in file are only text formatting
|
|
||
|
|
||
| class lmfit(FittingTemplate): # noqa: S101 | ||
| class LmFit(MinimizerBase): # noqa: S101 | ||
| """ | ||
| This is a wrapper to lmfit: https://lmfit.github.io/ |
There was a problem hiding this comment.
The correct link is https://lmfit.github.io/lmfit-py/
The current link gives a 404
|
|
||
|
|
||
| class lmfit(FittingTemplate): # noqa: S101 | ||
| class LmFit(MinimizerBase): # noqa: S101 |
There was a problem hiding this comment.
I am not sure about CamelCase here.
LM stands for Levenberg-Marquardt - maybe LMFit ? This would be similar to other acronym-containing class names. Did we agree on naming?
There was a problem hiding this comment.
Yes, you are right. It seems better to have acronyms capitalized in a class name.
There was a problem hiding this comment.
I just didn't remember if we said anything about acronyms in names, but considering we are dealing with many of those (e.g. QENS, INS) we should have a clear rule
There was a problem hiding this comment.
In my opinion:
- module names should always be small caps (file tree)
- class names should have CamelCase for the individual words. If acronym is part of the name it should be ALLCAPS
There was a problem hiding this comment.
I guess this should be an ADR on the organization level.
This PR is just preparation for more fundamental changes of the Fitter code base. No changes have yet been made to the logic. Only moving stuff around to clarify what is going on.
Next step is to make tests.
Main changes
Split
Fitting.pyinto:fitter.pymulti_fitter.pyIntroduce dir for the minimizers (engines)
Fitting.minimizersRenaming:
fitting_template.py->minimizer_base.pyExtracted functionality from
minimizer.minimizer_base.pyintominimizer.utils.pyMoved fitter test from
unit_testsintointegration_testsOnly change to module import path:
Objects.Inferface.py, other changes are just text formatting