Add gallery example "Scale bar" by yvonnefroehlich · Pull Request #2822 · GenericMappingTools/pygmt

yvonnefroehlich · 2023-11-19T19:08:18Z

Description of proposed changes

This PR aims to add a gallery example showing how to configurate a scale bar:

list of available modifiers
code examples
seperate PR Figure.coast: Add alias "box" for "-F" #2823 (similar to pygmt.Figure.basemap)

Upstream GMT documentation:

Preview: https://pygmt-dev--2822.org.readthedocs.build/en/2822/gallery/embellishments/scalebar.html

Fixes #2627

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.
Use underscores (not hyphens) in names of Python files and directories.

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

yvonnefroehlich · 2023-11-19T19:15:37Z

/format

examples/gallery/embellishments/scalebar.py

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

michaelgrund · 2023-12-19T14:02:57Z

examples/gallery/embellishments/scalebar.py

+# -----------------------------------------------------------------------------
+# Add a thick scale bar
+# Adjust the GMT default parameter MAP_SCALE_HEIGHT locally (the change applies
+# only to the code within the "with" block)


Suggested change

# only to the code within the "with" block)

# only to the code within the "with" statement)

Hm. I am still not 100 % sure whether within the "with" statement sounds better than within the "with" block and makes sense. Maybe we can write under the "with" statement if we want to use statement instead of block?

I feel 'within the "with" statement' is better.

OK. Should I also update the formulations in the Figure.inset line example:

pygmt/pygmt/src/inset.py

Lines 119 to 131 in 06ae818

>>> # Use a "with" statement to initialize the inset context manager

>>> # Setting the position to top left and a width of 3.5 centimeters

>>> with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box="+pgreen"):

... # Map elements under the "with" statement are plotted in the inset

... fig.coast(

... region="g",

... projection="G47/-20/3.5c",

... land="gray",

... water="white",

... dcw="MG+gred",

... )

...

>>> # Map elements outside the "with" block are plotted in the main figure

examples/gallery/embellishments/scalebar.py

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>

examples/gallery/embellishments/scalebar.py

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Add basic code and documentation

d5394f2

yvonnefroehlich added the documentation Improvements or additions to documentation label Nov 19, 2023

yvonnefroehlich added this to the 0.11.0 milestone Nov 19, 2023

yvonnefroehlich self-assigned this Nov 19, 2023

actions-bot and others added 2 commits November 19, 2023 19:16

[format-command] fixes

3808564

Remove 'box'

38540cb

This comment was marked as off-topic.

Sign in to view

Merge branch 'main' into add-gallery-scalebar

bbf06d2

This comment was marked as off-topic.

Sign in to view

Merge branch 'main' into add-gallery-scalebar

8b8bad7

michaelgrund reviewed Nov 21, 2023

View reviewed changes

examples/gallery/embellishments/scalebar.py Outdated Show resolved Hide resolved

examples/gallery/embellishments/scalebar.py Outdated Show resolved Hide resolved

examples/gallery/embellishments/scalebar.py Outdated Show resolved Hide resolved

Yvonne Fröhlich and others added 3 commits November 21, 2023 13:10

Expand documentation

0851337

Update example for 'box'

1bec367

Merge branch 'main' into add-gallery-scalebar

0804898

This comment was marked as off-topic.

Sign in to view

seisman mentioned this pull request Nov 30, 2023

doc: Update the extlinks settings for Sphinx > 6 #2840

Merged

yvonnefroehlich and others added 11 commits December 1, 2023 07:13

Merge branch 'main' into add-gallery-scalebar

6d14f88

Merge branch 'main' into add-gallery-scalebar

617b715

Fix typos

5c169a7

Merge branch 'main' into add-gallery-scalebar

0875174

Use alias 'box' for 'F'

7a5c127

Merge branch 'main' into add-gallery-scalebar

dcd8941

Improve docs

54e7ed3

Add blank line at end of file

aa9fa95

Add comments

19468ea

Replace tabs by white spaces

9b8281c

Fix rst syntax

ec322e4

yvonnefroehlich added 3 commits December 19, 2023 09:26

Extend docs for position

beaa1a6

Add docs for distance unit

937fe2e

Use 'or' consistently

6023891

seisman reviewed Dec 19, 2023

View reviewed changes

yvonnefroehlich and others added 6 commits December 19, 2023 12:00

Fix typo

8f29791

Replace "|" by "or"

fcf3164

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Merge branch 'main' into add-gallery-scalebar

0cfdf75

Fix line length

88baf28

Improv

b08b6be

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Fix line length and add article

d8065ed

michaelgrund reviewed Dec 19, 2023

View reviewed changes

yvonnefroehlich added the needs review This PR has higher priority and needs review. label Dec 19, 2023

seisman reviewed Dec 20, 2023

View reviewed changes

examples/gallery/embellishments/scalebar.py Outdated Show resolved Hide resolved

examples/gallery/embellishments/scalebar.py Outdated Show resolved Hide resolved

examples/gallery/embellishments/scalebar.py Outdated Show resolved Hide resolved

yvonnefroehlich and others added 4 commits December 20, 2023 10:43

Fix typo

fd504d0

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Improve argument passed to 'xshift'

cf0d1a6

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Improve argument passed to 'xshift'

1335750

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Improve formulation

5e519ad

Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>

seisman approved these changes Dec 23, 2023

View reviewed changes

yvonnefroehlich added 2 commits December 24, 2023 14:04

Combine subplots into one plot

311cca7

Adjust thumbnail image

40fd4f8

seisman approved these changes Dec 24, 2023

View reviewed changes

examples/gallery/embellishments/scalebar.py Outdated Show resolved Hide resolved

seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Dec 24, 2023

yvonnefroehlich and others added 3 commits December 24, 2023 16:01

Use consistently a width of 500 kilometers

c8f27c1

Reduce thickness of scale bar

60dea40

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Merge branch 'main' into add-gallery-scalebar

9f73a45

seisman merged commit ff1af6b into main Dec 25, 2023

seisman deleted the add-gallery-scalebar branch December 25, 2023 10:27

seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 25, 2023

yvonnefroehlich mentioned this pull request Dec 26, 2023

Figure.inset: Improve formulation of comment in inline example #2920

Merged

7 tasks

	# only to the code within the "with" block)
	# only to the code within the "with" statement)

	>>> # Use a "with" statement to initialize the inset context manager
	>>> # Setting the position to top left and a width of 3.5 centimeters
	>>> with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box="+pgreen"):
	... # Map elements under the "with" statement are plotted in the inset
	... fig.coast(
	... region="g",
	... projection="G47/-20/3.5c",
	... land="gray",
	... water="white",
	... dcw="MG+gred",
	... )
	...
	>>> # Map elements outside the "with" block are plotted in the main figure

Conversation

yvonnefroehlich commented Nov 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yvonnefroehlich commented Nov 19, 2023

Uh oh!

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

Uh oh!

Uh oh!

Uh oh!

This comment was marked as off-topic.

This comment was marked as off-topic.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

michaelgrund Dec 19, 2023

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Dec 22, 2023

Choose a reason for hiding this comment

Uh oh!

seisman Dec 22, 2023

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Dec 22, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

yvonnefroehlich commented Nov 19, 2023 •

edited

Loading