Skip to content

Add intro tutorial section for creating contour map - #2126

Merged
seisman merged 23 commits into
mainfrom
tutorial/contour-map
Oct 31, 2022
Merged

Add intro tutorial section for creating contour map#2126
seisman merged 23 commits into
mainfrom
tutorial/contour-map

Conversation

@willschlitzer

@willschlitzerwillschlitzer commented Sep 20, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

This adds a second section to the Intro to PyGMT tutorial. It covers retrieving and plotting Earth relief data, adding a color palette and color bar, and plotting contour lines.

Preview at https://pygmt-dev--2126.org.readthedocs.build/en/2126/get-started/contour-map.html

Addresses #770

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • 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

@willschlitzerwillschlitzer added the documentation Improvements or additions to documentation label Sep 20, 2022
@willschlitzerwillschlitzer added this to the 0.8.0 milestone Sep 20, 2022
@willschlitzerwillschlitzer self-assigned this Sep 20, 2022
@willschlitzerwillschlitzer changed the title WIP: Add intro tutorial section for plotting Earth relief dataAdd intro tutorial section for plotting Earth relief dataSep 23, 2022
@willschlitzer
willschlitzer marked this pull request as ready for review September 23, 2022 11:36
@willschlitzerwillschlitzer mentioned this pull request Sep 23, 2022
Open
6 tasks
seisman
seisman reviewed Sep 24, 2022
View reviewed changes
Comment threadexamples/get-started/contour-map.py Outdated
Comment threadexamples/get-started/contour-map.py Outdated
seisman
seisman reviewed Oct 14, 2022
View reviewed changes
Comment threadexamples/get-started/contour-map.py
seisman
seisman reviewed Oct 20, 2022
View reviewed changes
Comment threadexamples/get-started/contour-map.py Outdated
weiji14
weiji14 reviewed Oct 20, 2022
View reviewed changes
Comment threadexamples/get-started/contour-map.py Outdated
Comment threadexamples/get-started/contour-map.py Outdated
Comment threadexamples/get-started/contour-map.py Outdated
Comment on lines +116 to +118
# 1. Change the resolution of the grid file to either "01m" (lower resolution)
# or "15s" (higher resolution). Note that higher resolution grids will have
# larger file sizes.

@weiji14weiji14Oct 20, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe link to https://www.generic-mapping-tools.org/remote-datasets/earth-relief.html#usage so users know what are the possible spatial resolutions, and mention explicitly that 01m stands for 1 arc minute (some people might think it's 1 meter).

Comment threadexamples/get-started/contour-map.py Outdated
@weiji14weiji14 added the final review call This PR requires final review and approval from a second reviewer label Oct 20, 2022
@seisman

seisman commented Oct 28, 2022

Copy link
Copy Markdown
Member

Ping @willschlitzer to finalize this PR so that we can merge it.

seisman
seisman reviewed Oct 31, 2022
View reviewed changes
Comment thread.github/workflows/cache_data.yaml Outdated
@seisman
seisman requested a review from weiji14October 31, 2022 01:36
@weiji14weiji14 changed the title Add intro tutorial section for plotting Earth relief dataAdd intro tutorial section for creating contour mapOct 31, 2022
weiji14
weiji14 approved these changes Oct 31, 2022
View reviewed changes

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks @willschlitzer! Just need to comment that pull_request: line in .github/workflows/cache_data.yaml as mentioned in https://github.com/GenericMappingTools/pygmt/pull/2126/files#r1008968590 before merging.

@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 31, 2022
@seisman
seisman merged commit 952e754 into mainOct 31, 2022
@seisman
seisman deleted the tutorial/contour-map branch October 31, 2022 07:20
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@willschlitzer@seisman
@weiji14Josh Sixsmith
Add intro tutorial section for creating contour map (GenericMappingTo…
8776cb5
…ols#2126)
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seismanseismanseisman approved these changes
@yvonnefroehlichyvonnefroehlichyvonnefroehlich left review comments
@weiji14weiji14weiji14 approved these changes

Assignees

@willschlitzerwillschlitzer

Labels

documentationImprovements or additions to documentation

Projects

None yet

Milestone

0.8.0

Development

Successfully merging this pull request may close these issues.

4 participants

@willschlitzer@seisman@weiji14@yvonnefroehlich