Add inline example for grdvolume #1726
Merged
Conversation
This file contains 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
25 tasks
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
seisman
reviewed
Mar 7, 2022
seisman
approved these changes
Mar 7, 2022
|
Need to fix the styling issue before merge. |
seisman
added
final review call
seisman
reviewed
Mar 8, 2022
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
seisman
approved these changes
Mar 11, 2022
seisman
added
the
final review call
maxrjones
reviewed
Mar 11, 2022
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
maxrjones
reviewed
Mar 11, 2022
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
weiji14
reviewed
Mar 12, 2022
| >>> # maximum to 400, and the interval to 50. | ||
| >>> output_array = pygmt.grdvolume( | ||
| ... grid=grid, contour=[200, 400, 50], output_type="numpy" | ||
| ... ) | ||
| """ |
There was a problem hiding this comment.
Ideally, we would have nice column names like in grdhisteq:
Lines 301 to 309 in d85bfdf
But for the sake of time, and just finish this inline example, let's go with this:
Suggested change
| """ | |
| >>> print(output_dataframe) | |
| 0 1 2 3 | |
| 0 200 2.144285e+12 7.972228e+14 371.789489 | |
| 1 250 2.104042e+12 6.908183e+14 328.329232 | |
| 2 300 2.014978e+12 5.877195e+14 291.675420 | |
| 3 350 1.892109e+12 4.897545e+14 258.840510 | |
| 4 400 1.744792e+12 3.988316e+14 228.584026 | |
| """ |
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
willschlitzer
removed
the
final review call
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
* Add an inline example to grdvolume.py Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com> Co-authored-by: Dongdong Tian <seisman.info@gmail.com> Co-authored-by: Meghan Jones <meghanj@alum.mit.edu> Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
This pull request was closed.
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.
This PR adds an inline code example to the docstring for
grdvolume.Addresses #1686
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 commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version