A gallery example for the contour method by yohaimagen · Pull Request #1387 · GenericMappingTools/pygmt

yohaimagen · 2021-07-17T12:02:58Z

Description of proposed changes

In response to issue #1340 adding a gallery example for the contour method.

Preview at https://pygmt-git-fork-yohaimagen-contour-gallery-example-gmt.vercel.app/gallery/images/contours.html

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

welcome · 2021-07-17T12:02:59Z

💖 Thanks for opening this pull request! 💖

Please make sure you read our contributing guidelines and abide by our code of conduct.

A few things to keep in mind:

If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
No matter what, we are really grateful that you put in the effort to do this! 🎉

maxrjones · 2021-07-17T16:44:10Z

/format

maxrjones

Great work @yohaimagen; thanks for addressing this issue! I have made a few suggestions on this pull request. If you agree with the suggestions, you can commit the changes using these steps:

Click on the 'Files changed' tab in the pull request
For each comment, you can click 'commit suggestion' in order to commit the suggestions one at a time or click 'add suggestion to batch', which allows you to commit multiple suggestions at once. If you plan to accept multiple suggestions, I recommend using the 'add suggestion to batch' option.

2a. If you clicked 'commit suggestion', you'll see a pop-up where you can enter a descriptive commit message and then click 'commit changes'.
2b. If you clicked 'add suggestion to batch', after reviewing all the suggestions, you can click 'commit suggestions' near the top of the 'files changed' tab. This will similarly prefill a commit message and allow you to commit the changes.

Feel free to reach out if you have any questions!

examples/gallery/lines/contours.py

…ce to numpy ndarray, adding units to pen.

yohaimagen · 2021-07-18T08:05:47Z

Sorry, I didn't saw your suggestions before adding some of my own, I incorporate some of your suggestions into mine.

maxrjones · 2021-07-19T01:14:10Z

/format

maxrjones

No worries, your revisions are great! I have made a set of small comments, mostly related to sphinx formatting, which can be really particular. I also recommended to increase the contour spacing from 5 to 10 in order to make it easier to see the difference between the contour spacing and the annotation spacing.

examples/gallery/lines/contours.py

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

yohaimagen · 2021-07-19T03:49:18Z

Great, I committed all of your suggestions @meghanrjones. I think that this gallery example is done :)

yohaimagen · 2021-07-19T04:41:26Z

One last thing, maybe it will be better to put this example under "Images, contours, and fields" than under "Lines and vectors".

maxrjones

Great work!

We usually leave approved pull requests open for ~1 day or until we get a second approval before merging, just in case other maintainers see anything major that needs adjusting.

examples/gallery/images/contours.py

Co-authored-by: Will Schlitzer <schlitzer90@gmail.com>

welcome · 2021-07-20T22:51:49Z

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

maxrjones · 2021-07-20T23:21:14Z

Great work @yohaimagen, congratulations on merging the PR! 🎉 We hope to see you around more 😄

weiji14 · 2021-07-20T23:50:10Z

Cheers @yohaimagen! Your gallery example is now live at https://www.pygmt.org/dev/gallery/index.html#images-contours-and-fields. Well done! 🥳

* Initial commit for contour gallery example * Explain the acceptable data formats, levels, and annotation parameters. * Add a bit more explanation on the implementation, adding a reference to numpy ndarray, adding units to pen. Co-authored-by: Meghan Jones <meghanj@alum.mit.edu> Co-authored-by: Will Schlitzer <schlitzer90@gmail.com>

Initial commit for contour gallery example

958a513

vercel bot temporarily deployed to Preview July 17, 2021 12:03 Inactive

weiji14 added documentation Improvements or additions to documentation scipy-sprint Things to work on during the SciPy sprint! labels Jul 17, 2021

yohaimagen marked this pull request as ready for review July 17, 2021 12:05

adding a simple gallery example to the useability of contours.

b0a0908

vercel bot temporarily deployed to Preview July 17, 2021 12:20 Inactive

weiji14 changed the title ~~A gallery example for the contour method.~~ A gallery example for the contour method Jul 17, 2021

maxrjones reviewed Jul 17, 2021

View reviewed changes

Explain the acceptable data formats, levels, and annotation parameters.

0b0cbbf

vercel bot temporarily deployed to Preview July 18, 2021 05:52 Inactive

adding inline comments

4cf47a2

vercel bot temporarily deployed to Preview July 18, 2021 06:01 Inactive

minor corections

c105d4a

vercel bot temporarily deployed to Preview July 18, 2021 06:21 Inactive

adding a bit more explanation on the implementation, adding a referen…

6d4d3ee

…ce to numpy ndarray, adding units to pen.

vercel bot temporarily deployed to Preview July 18, 2021 08:02 Inactive

[format-command] fixes

9b4e4f5

vercel bot temporarily deployed to Preview July 19, 2021 01:15 Inactive

maxrjones reviewed Jul 19, 2021

View reviewed changes

examples/gallery/lines/contours.py Outdated Show resolved Hide resolved

Update examples/gallery/lines/contours.py

3c555fb

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

vercel bot temporarily deployed to Preview July 19, 2021 03:34 Inactive

yohaimagen and others added 3 commits July 19, 2021 06:34

Update examples/gallery/lines/contours.py

7b4b5a0

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

Update examples/gallery/lines/contours.py

7b7724f

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

Update examples/gallery/lines/contours.py

e07aed8

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

yohaimagen and others added 5 commits July 19, 2021 06:36

Update examples/gallery/lines/contours.py

503ccef

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

Update examples/gallery/lines/contours.py

a703a8b

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

Update examples/gallery/lines/contours.py

0cf899c

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

Update examples/gallery/lines/contours.py

72f99e5

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

Update examples/gallery/lines/contours.py

64eded0

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

vercel bot temporarily deployed to Preview July 19, 2021 03:42 Inactive

moving the example from lines to images

71bf265

vercel bot temporarily deployed to Preview July 19, 2021 04:45 Inactive

maxrjones approved these changes Jul 19, 2021

View reviewed changes

core-man mentioned this pull request Jul 19, 2021

Improve review processs seismo-learn/contributing#47

Open

willschlitzer reviewed Jul 19, 2021

View reviewed changes

examples/gallery/images/contours.py Outdated Show resolved Hide resolved

Update examples/gallery/images/contours.py

6529a9d

Co-authored-by: Will Schlitzer <schlitzer90@gmail.com>

vercel bot temporarily deployed to Preview July 20, 2021 05:25 Inactive

maxrjones added the final review call This PR requires final review and approval from a second reviewer label Jul 20, 2021

maxrjones merged commit 9b60f5c into GenericMappingTools:master Jul 20, 2021

maxrjones removed the final review call This PR requires final review and approval from a second reviewer label Jul 20, 2021

Conversation

yohaimagen commented Jul 17, 2021 • edited by weiji14 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

welcome bot commented Jul 17, 2021

Uh oh!

maxrjones commented Jul 17, 2021

Uh oh!

maxrjones left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yohaimagen commented Jul 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maxrjones commented Jul 19, 2021

Uh oh!

maxrjones left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yohaimagen commented Jul 19, 2021

Uh oh!

yohaimagen commented Jul 19, 2021

Uh oh!

maxrjones left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

welcome bot commented Jul 20, 2021

Uh oh!

maxrjones commented Jul 20, 2021

Uh oh!

weiji14 commented Jul 20, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

yohaimagen commented Jul 17, 2021 •

edited by weiji14

Loading

maxrjones left a comment •

edited

Loading

yohaimagen commented Jul 18, 2021 •

edited

Loading