Rename equivalent sources classes #255
Conversation
Add test function that checks if predictions are equivalent and if FutureWarning is raised on initialization.
Add test function that checks if predictions are equivalent and if FutureWarning is raised on initialization.
Co-authored-by: Leonardo Uieda <[email protected]>
|
Thanks @leouieda for the review. Yes, I need to double check if I've changed "layer" everywhere else (besides the docs, which need some work). I do have some doubts: we used to use One more thing: I was thinking to leave the "equivalent layer" name somewhere in the docs so it could be indexed by search engines, just in case someone is looking for an "equivalent layer" implementation instead of an "equivalent sources" one. |
|
That's a good point about the search terms. It may be good to leave it in a tutorial or the docstring as something like "equivalent sources (a.k.a. equivalent layer)" or something like that.
How about |
Replace EQLHarmonic and EQLHarmonicSpherical with EquivalentSources and EquivalentSourcesSph, respectively. Change every use of "equivalent layer" to "equivalent sources". Use the eqs variable for the gridder instances.
This reverts commit 85e15e8.
Rename
EQLHarmonicandEQLHarmonicSphericalclasses toEquivalentSourcesand
EquivalentSourcesSph, respectively. Refactor files organization: renameequivalent_layerdirectory toequivalent_sourcesand the sources files tocartesian.pyandspherical.py. Split the file with the tests function bycoordinate system: Cartesian and spherical. Rename some tests functions. Add
new child classes
EQLHarmonicandEQLHarmonicSphfor backwardscompatibility that raise a
FutureWarningwhen initialized. Update galleryexamples and documentation pages to use "equivalent sources" instead of
"equivalent layer". Mention "equivalent layer" in one gallery example though.
Rename
eqlvariables in examples and tests witheqs.TODO:
eqlvariables in the examples and testsFixes #250