Skip to content

DOC: Add gallery example for magnetic rose#4381

Merged
seisman merged 17 commits intomainfrom
add-gallery-magrose
Mar 19, 2026
Merged

DOC: Add gallery example for magnetic rose#4381
seisman merged 17 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.

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.

@seisman
Copy link
Member

seisman commented Feb 20, 2026

I feel a large rose looks better.

@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review March 13, 2026 16:45
@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Add gallery example for magnetic rose DOC: Add gallery example for magnetic rose Mar 18, 2026
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Mar 19, 2026
@seisman seisman requested a review from Copilot March 19, 2026 08:46
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new PyGMT gallery example demonstrating how to place and customize a magnetic rose on a map using the high-level Figure.magnetic_rose method.

Changes:

  • Introduces a new gallery example script for Figure.magnetic_rose.
  • Demonstrates default placement plus a customized magnetic rose (position, size, pens, labels, declination/label).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@seisman seisman merged commit 9f64cd2 into main Mar 19, 2026
9 checks passed
@seisman seisman deleted the add-gallery-magrose branch March 19, 2026 10:04
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 19, 2026
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.

4 participants