-
Notifications
You must be signed in to change notification settings - Fork 258
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
MAINT: Rename Spontaneous Potential module to Self Potential #1408
Comments
cc @sgkang: I would be curious to get your thoughts on this as you were the first to implement it in SimPEG! |
I agree that "self potential" is the more common usage - in volcanology at least. |
I have no real preference either way, but my original thought in #1211 was that since the word |
Thanks for sharing the initial motivation Joe, I can see the motivation with (and as a side note, I don't find |
Deprecate the `spontaneous_potential` module and replace it by the new `self_potential`. Raise warning when importing the deprecated module. Add tests that check the warning and if all modules in `self_potential` are made available also in the deprecated module. Update API reference to apply the replacement. Closes #1408 --------- Co-authored-by: Santiago Soler <santisoler@fastmail.com> Co-authored-by: Joseph Capriotti <josephrcapriotti@gmail.com>
I propose that we rename the
spontaneous_potential
module toself_potential
. Although both names are used to indicate the same phenomenon, "Self Potential" is used more broadly to describe the geophysical survey (spontaneous potential is used primarily in the context of well logging).If we look at formative references on the topic, for example Revil and Jardani and Telford, they also refer to Self Potential
Since this is a relatively recent addition to SimPEG, making the change sooner than later shouldn't be too painful, so I have put this as a candidate for the 0.22 milestone
The text was updated successfully, but these errors were encountered: