Skip to content

WIP: DOC: Add gallery example for magnetic rose#4381

Draft
yvonnefroehlich wants to merge 7 commits intomainfrom
add-gallery-magrose
Draft

WIP: DOC: Add gallery example for magnetic rose#4381
yvonnefroehlich wants to merge 7 commits intomainfrom
add-gallery-magrose

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Feb 1, 2026

Description of proposed changes

This aims to add a gallery example for adding a magnetic rose to a map using the newly implemented high-level method Figure.pygmt.magnetic_rose.

  • Show default behaviour
  • Customize appearance via one large rose instead of several small roses for better visibility.
  • Label added to declination arrow does not support white spaces (even with using single and double quotation marks).
  • [ ]

Preview:

https://pygmt-dev--4381.org.readthedocs.build/en/4381/gallery/embellishments/magnetic_rose.html

Guidelines

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 yvonnefroehlich added this to the 0.19.0 milestone Feb 1, 2026
@yvonnefroehlich yvonnefroehlich self-assigned this Feb 1, 2026
@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Feb 1, 2026
@yvonnefroehlich yvonnefroehlich marked this pull request as draft February 1, 2026 18:39
@yvonnefroehlich
Copy link
Member Author

So far, I plot two magnetic roses in this gallery example into one map:

(i) one for the default behavior of the Figure.magnetic_rose method
(ii) one large rose to show different options to adjust the appearance

@GenericMappingTools/pygmt-maintainers, before I continue here, what do you think? Should we go with plotting one large rose or have it like the gallery examples of Figure.scalebar and Figure.directional_rose and plot several small roses? I feel for small magnetic roses the details can be difficult to see.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant