Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename EQLHarmonic and EQLHarmonicSpherical classes into something more meaningful #250

Closed
santisoler opened this issue Oct 18, 2021 · 0 comments · Fixed by #255
Closed
Labels
enhancement Idea or request for a new feature

Comments

@santisoler
Copy link
Member

Description of the desired feature:

I would like to rename the equivalent layer/sources classes to something more meaningful.
Since both classes work with point sources rather an actual layer of mass distribution, I would be more prone to include "equivalent sources" in their name.
On the other hand, I don't think we should specify the "harmonic" nature of the fields these classes generate.
We don't have another type of equivalent sources interpolations, so I think we should not include the "harmonic" part until we really need someway to differentiate them from others (maybe we should differentiate future classes from these two instead).

I would like to add some backward compatibility on this, specially after the Harmonica tutorial at Transform21.
Maybe we could create two new child classes (whose names are EQLHarmonic and EQLHarmonicSpherical) that raises a FutureWarning after initialization.

Proposals:

  • EquivalentSources and EquivalentSourcesSpherical
  • EqSources and EqSourcesSpherical
@santisoler santisoler added the enhancement Idea or request for a new feature label Oct 18, 2021
@santisoler santisoler added this to the v0.3 milestone Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Idea or request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant