DOC: Add gallery example to show usage of map roses #4010

michaelgrund · 2025-07-23T15:01:21Z

Description of proposed changes

This PR adds a gallery example to show the usage of map roses.

Preview:

https://pygmt-dev--4010.org.readthedocs.build/en/4010/gallery/embellishments/map_roses.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 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 command is:

/format: automatically format and lint the code

yvonnefroehlich · 2025-07-23T15:36:12Z

Cool - will look at the plots in detail later on.

But just want to mention that there is an issue suggesting to implemente a high-level methods for plotting a directional rose etc. at #2831 (similar to plot / plot3d at #2797). Not sure if there is any progress at the moment, but would be good to check to avoid double work 🙃. As the script contains various plots, it looks like you put already some work into this PR.

examples/gallery/embellishments/map_roses.py

seisman · 2025-07-24T01:47:41Z

But just want to mention that there is an issue suggesting to implemente a high-level methods for plotting a directional rose etc. at #2831 (similar to plot / plot3d at #2797). Not sure if there is any progress at the moment

It's still waiting for the new alias system.

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

seisman · 2025-07-24T07:41:39Z

Instead of plotting eight roses in eight subplots, maybe it's better to plot eight roses in a single basemap?

examples/gallery/embellishments/map_roses.py

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

examples/gallery/embellishments/map_roses.py

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

examples/gallery/embellishments/map_roses.py

seisman · 2025-07-29T07:45:53Z

@michaelgrund @yvonnefroehlich I've opened PR #4025 which adds the Figure.directional_rose method. With that feature added, this gallery example can be greatly simplified. So better to focus on that PR first?

michaelgrund · 2025-07-30T05:41:43Z

@michaelgrund @yvonnefroehlich I've opened PR #4025 which adds the Figure.directional_rose method. With that feature added, this gallery example can be greatly simplified. So better to focus on that PR first?

Great, will wait until #4025 is merged!

seisman · 2026-01-23T03:24:37Z

@michaelgrund The Figure.directional_rose method in PR #4025 has been merged. You may want to revisit this example if you're still interested.

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

michaelgrund · 2026-01-28T09:40:03Z

/format

michaelgrund · 2026-01-28T09:45:48Z

/format

yvonnefroehlich

Overall the comments can be rewrapped to use the maximum line length.

examples/gallery/embellishments/map_roses.py

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

examples/gallery/embellishments/map_roses.py

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

seisman · 2026-01-29T12:32:52Z

examples/gallery/embellishments/map_roses.py

+y1 = 0
+width = "1.5c"
+
+fig.basemap(region=[-5, 80, -10, 32], projection="M10c", frame=True)


Perhaps we should have an example like Figure.magnetic_rose() without any arguments? It's the simplest way to use this method.

seisman · 2026-01-29T12:34:02Z

examples/gallery/embellishments/map_roses.py

+The :meth:`pygmt.Figure.directional_rose` method allows to add
+directional roses on maps when using :meth:`pygmt.Figure.basemap`
+or :meth:`pygmt.Figure.coast`. This example shows how such a map


Do not mention basemap/coast.

Suggested change

The :meth:`pygmt.Figure.directional_rose` method allows to add

directional roses on maps when using :meth:`pygmt.Figure.basemap`

or :meth:`pygmt.Figure.coast`. This example shows how such a map

The :meth:`pygmt.Figure.directional_rose` method allows to add

directional roses on maps. This example shows how such a map

yvonnefroehlich · 2026-01-29T14:15:26Z

examples/gallery/embellishments/map_roses.py

+# Fancy, 1.5 cm wide rose of level 2 and labels indicating the different
+# directions


Suggested change

# Fancy, 1.5 cm wide rose of level 2 and labels indicating the different

# directions

# Fancy, 1.5 cm wide rose of level 2 and labels indicating the different directions

or maybe just something similar to

Suggested change

# Fancy, 1.5 cm wide rose of level 2 and labels indicating the different

# directions

# Same rose but now of level 2

yvonnefroehlich · 2026-01-29T14:15:33Z

examples/gallery/embellishments/map_roses.py

+# Fancy, 1.5 cm wide rose of level 3 and labels indicating the different
+# directions


Suggested change

# Fancy, 1.5 cm wide rose of level 3 and labels indicating the different

# directions

# Fancy, 1.5 cm wide rose of level 3 and labels indicating the different directions

or maybe just something similar to

Suggested change

# Fancy, 1.5 cm wide rose of level 3 and labels indicating the different

# directions

# Same rose but now of level 3

yvonnefroehlich · 2026-01-29T14:15:46Z

examples/gallery/embellishments/map_roses.py

+# Fancy, 1.5 cm wide rose of level 2 with two labels indicating the West and
+# East directions. Colors of the rose and labels are defined via
+# MAP_DEFAULT_PEN, MAP_TICK_PEN_PRIMARY and FONT_TITLE, respectively


As these defaults were explained in the example before and are mentioned in the introduction text, I feel we do not need to repeat it for the following examples.

Suggested change

# Fancy, 1.5 cm wide rose of level 2 with two labels indicating the West and

# East directions. Colors of the rose and labels are defined via

# MAP_DEFAULT_PEN, MAP_TICK_PEN_PRIMARY and FONT_TITLE, respectively

# Fancy, 1.5 cm wide rose of level 2 with two labels indicating the West and

# East directions

yvonnefroehlich · 2026-01-29T14:16:10Z

examples/gallery/embellishments/map_roses.py

+# Fancy, 1.5 cm wide rose of level 3 with two labels indicating the North and
+# South directions. Colors of the rose and labels are defined via
+# MAP_DEFAULT_PEN, MAP_TICK_PEN_PRIMARY and FONT_TITLE, respectively


Suggested change

# Fancy, 1.5 cm wide rose of level 3 with two labels indicating the North and

# South directions. Colors of the rose and labels are defined via

# MAP_DEFAULT_PEN, MAP_TICK_PEN_PRIMARY and FONT_TITLE, respectively

# Fancy, 1.5 cm wide rose of level 3 with two labels indicating the North and

# South directions

DOC: Add gallery example to usage of map roses

2ea2061

michaelgrund added the documentation Improvements or additions to documentation label Jul 23, 2025

michaelgrund changed the title ~~DOC: Add gallery example to usage of map roses~~ DOC: Add gallery example to show usage of map roses Jul 23, 2025

michaelgrund added the needs review This PR has higher priority and needs review. label Jul 23, 2025

rm tws

929b669

yvonnefroehlich reviewed Jul 23, 2025

View reviewed changes

examples/gallery/embellishments/map_roses.py Show resolved Hide resolved

Apply suggestions from code review

5dac68f

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

yvonnefroehlich reviewed Jul 24, 2025

View reviewed changes

michaelgrund and others added 2 commits July 28, 2025 11:40

Apply suggestions from code review

d1f7d9e

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

Apply suggestions from code review

b682ff6

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

michaelgrund commented Jul 28, 2025

View reviewed changes

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

michaelgrund added 2 commits July 28, 2025 11:42

Apply suggestions from code review

0776071

Merge branch 'main' into gallery-map-roses

a4a5e50

yvonnefroehlich reviewed Jul 28, 2025

View reviewed changes

Apply suggestions from code review

c23f5c6

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

yvonnefroehlich reviewed Jul 28, 2025

View reviewed changes

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

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

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

yvonnefroehlich reviewed Jul 28, 2025

View reviewed changes

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

seisman mentioned this pull request Jul 29, 2025

Add Figure.directional_rose to plot a directional rose on map #4025

Merged

6 tasks

seisman removed the needs review This PR has higher priority and needs review. label Jul 30, 2025

seisman marked this pull request as draft July 30, 2025 11:20

seisman added this to the 0.18.0 milestone Sep 18, 2025

seisman modified the milestones: 0.18.0, 0.19.0 Dec 29, 2025

yvonnefroehlich mentioned this pull request Jan 6, 2026

Release PyGMT v0.18.0 #4289

Closed

30 tasks

michaelgrund and others added 3 commits January 28, 2026 09:51

Apply suggestions from code review

20e5926

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

Use new Figure.directional_rose method

edc3e43

Merge branch 'main' into gallery-map-roses

2df12c7

michaelgrund added 3 commits January 28, 2026 10:41

Update map_roses.py

3605a62

Update map_roses.py

2eced7a

Update map_roses.py

8cecbf1

actions-bot and others added 2 commits January 28, 2026 09:46

[format-command] fixes

7c00cf9

Update map_roses.py

6b17430

michaelgrund marked this pull request as ready for review January 28, 2026 09:49

michaelgrund added the needs review This PR has higher priority and needs review. label Jan 28, 2026

Update map_roses.py

ef363b8

yvonnefroehlich reviewed Jan 28, 2026

View reviewed changes

michaelgrund and others added 3 commits January 29, 2026 06:52

Apply suggestions from code review

5fd2e4c

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

Apply suggestions from code review

72b8683

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

Merge branch 'main' into gallery-map-roses

5e06f90

seisman reviewed Jan 29, 2026

View reviewed changes

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

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

michaelgrund and others added 4 commits January 29, 2026 10:32

Merge branch 'main' into gallery-map-roses

4c94f88

Update examples/gallery/embellishments/map_roses.py

55a7de7

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

Update map_roses.py

6f57880

Merge branch 'main' into gallery-map-roses

4f8e06d

seisman reviewed Jan 29, 2026

View reviewed changes

yvonnefroehlich reviewed Jan 29, 2026

View reviewed changes

		# Fancy, 1.5 cm wide rose of level 2 and labels indicating the different
		# directions

	# Fancy, 1.5 cm wide rose of level 2 and labels indicating the different
	# directions
	# Same rose but now of level 2

		# Fancy, 1.5 cm wide rose of level 3 and labels indicating the different
		# directions

	# Fancy, 1.5 cm wide rose of level 3 and labels indicating the different
	# directions
	# Same rose but now of level 3

DOC: Add gallery example to show usage of map roses #4010

Are you sure you want to change the base?

DOC: Add gallery example to show usage of map roses #4010

Uh oh!

Conversation

michaelgrund commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yvonnefroehlich commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

seisman commented Jul 24, 2025

Uh oh!

seisman commented Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Jul 29, 2025

Uh oh!

michaelgrund commented Jul 30, 2025

Uh oh!

seisman commented Jan 23, 2026

Uh oh!

michaelgrund commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelgrund commented Jan 28, 2026

Uh oh!

yvonnefroehlich 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!

Uh oh!

Uh oh!

Uh oh!

seisman Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

seisman Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

michaelgrund commented Jul 23, 2025 •

edited

Loading

yvonnefroehlich commented Jul 23, 2025 •

edited

Loading

michaelgrund commented Jan 28, 2026 •

edited

Loading