Figure.meca: Improve documentation #3517
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yvonnefroehlich
added
documentation
yvonnefroehlich
changed the title
yvonnefroehlich
changed the title
|
/format |
yvonnefroehlich
changed the title
yvonnefroehlich
changed the title
Closed
49 tasks
|
@yvonnefroehlich What's the status of this PR? Do you think we can finish it in v0.14.0? |
yvonnefroehlich
commented
Dec 24, 2024
I just resolved the merge conflicts and will look later what is missing here. |
seisman
reviewed
Dec 25, 2024
seisman
reviewed
Dec 26, 2024
Co-authored-by: Dongdong Tian <[email protected]>
yvonnefroehlich
changed the title
seisman
reviewed
Dec 27, 2024
seisman
reviewed
Dec 27, 2024
pygmt/src/meca.py
Outdated
Comment on lines
253
to
262
| convention. For the different conventions, the following combination of keys/ | ||
| column names are required: | ||
|
|
||
| - ``"aki"``: *strike*, *dip*, *rake*, *magnitude* | ||
| - ``"gcmt"``: *strike1*, *dip1*, *rake1*, *strike2*, *dip2*, *rake2*, | ||
| *mantissa*, *exponent* | ||
| - ``"mt"``: *mrr*, *mtt*, *mff*, *mrt*, *mrf*, *mtf*, *exponent* | ||
| - ``"partial"``: *strike1*, *dip1*, *strike2*, *fault_type*, *magnitude* | ||
| - ``"principal_axis"``: *t_value*, *t_azimuth*, *t_plunge*, *n_value*, | ||
| *n_azimuth*, *n_plunge*, *p_value*, *p_azimuth*, *p_plunge*, *exponent* |
There was a problem hiding this comment.
What about adding a table about focal mechanism conventions before the parameter list, then we can shorten this part. The table can be like:
| Convention | Description | Focal parameters |
|---|---|---|
"aki" |
Aki & Richard | strike, dip, rake, magnitude |
| ... | ... | ... |
Of course, it can be done in future PRs if you prefer to have this PR merged in v0.14.0
There was a problem hiding this comment.
I think this is a good idea. A table makes these different options more readable. And later we can point to this table in the beachball tutorial and short the introduction part there. Can give it a try in a separat PR.
Co-authored-by: Dongdong Tian <[email protected]>
seisman
approved these changes
Dec 28, 2024
This was referenced Feb 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Some improvements of the documetation of
Figure.meca:Preview: https://pygmt-dev--3517.org.readthedocs.build/en/3517/api/generated/pygmt.Figure.meca.html
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code