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

MAINT: Rename Spontaneous Potential module to Self Potential #1408

Closed
lheagy opened this issue Apr 6, 2024 · 4 comments · Fixed by #1422
Closed

MAINT: Rename Spontaneous Potential module to Self Potential #1408

lheagy opened this issue Apr 6, 2024 · 4 comments · Fixed by #1422
Milestone

Comments

@lheagy
Copy link
Member

lheagy commented Apr 6, 2024

I propose that we rename the spontaneous_potential module to self_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

@lheagy lheagy added this to the 0.22.0 milestone Apr 6, 2024
@lheagy
Copy link
Member Author

lheagy commented Apr 6, 2024

cc @sgkang: I would be curious to get your thoughts on this as you were the first to implement it in SimPEG!

@lheagy lheagy changed the title Rename Spontaneous Potential module to Self Potential MAINT: Rename Spontaneous Potential module to Self Potential Apr 6, 2024
@craigmillernz
Copy link
Contributor

I agree that "self potential" is the more common usage - in volcanology at least.

@jcapriot
Copy link
Member

I have no real preference either way, but my original thought in #1211 was that since the word self has its own importance in Python, it would be fine to stick to spontaneous

@lheagy
Copy link
Member Author

lheagy commented Apr 14, 2024

Thanks for sharing the initial motivation Joe, I can see the motivation with self. Here, I would still advocate that we prioritize following the geophysics community and go with the more common name of self_potential, as it is the description most used in the literature we are connected with.

(and as a side note, I don't find spontaneous as fitting of a description, when you look at the definition, there is an emphasis on something being "sudden" which may or may not be the case when talking about the potentials being generated)

santisoler added a commit that referenced this issue May 1, 2024
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants