DOC: Add gallery example to show usage of map roses #4010
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelgrund
changed the title
michaelgrund
added
the
needs review
|
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 |
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
|
Instead of plotting eight roses in eight subplots, maybe it's better to plot eight roses in a single basemap? |
| independent) code. Choose from vertical **T**\(op), **M**\(iddle), or | ||
| **B**\(ottom) and horizontal **L**\(eft), **C**\(entre), or **R**\(ight). | ||
|
|
||
| - label: **+l**[w,e,s,n]: Label the cardinal points W,E,S,N. Optionally, |
There was a problem hiding this comment.
Suggested change
| - label: **+l**[w,e,s,n]: Label the cardinal points W,E,S,N. Optionally, | |
| - label: **+l**\[w,e,s,n]: Label the cardinal points W,E,S,N. Optionally, |
| - width: **+w**: Set the width of the rose in plot coordinates (append | ||
| **i** (inch), **cm** (centimeters), or **p** (points). | ||
|
|
||
| - fanciness: **+f**[level]: Get a “fancy” rose, and optionally specify the |
There was a problem hiding this comment.
Suggested change
| - fanciness: **+f**[level]: Get a “fancy” rose, and optionally specify the | |
| - fanciness: **+f** \[level]: Get a “fancy” rose, and optionally specify the |
| - width: **+w**: Set the width of the rose in plot coordinates (append | ||
| **i** (inch), **cm** (centimeters), or **p** (points). | ||
|
|
||
| - fanciness: **+f**[level]: Get a “fancy” rose, and optionally specify the |
There was a problem hiding this comment.
Suggested change
| - fanciness: **+f**[level]: Get a “fancy” rose, and optionally specify the | |
| - fanciness: **+f**[level]: Get a "fancy" rose, and optionally specify the |
| level of fanciness. Level 1 draws the two principal E-W, N-S orientations, | ||
| 2 adds the two intermediate NW-SE and NE-SW orientations, while 3 adds | ||
| the eight minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and ENE-WSW | ||
| [default is 1]. |
There was a problem hiding this comment.
Suggested change
| [default is 1]. | |
| [Default is 1]. |
Comment on lines
+24
to
+28
| - fanciness: **+f**[level]: Get a “fancy” rose, and optionally specify the | ||
| level of fanciness. Level 1 draws the two principal E-W, N-S orientations, | ||
| 2 adds the two intermediate NW-SE and NE-SW orientations, while 3 adds | ||
| the eight minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and ENE-WSW | ||
| [default is 1]. |
There was a problem hiding this comment.
What's about having a list here?
Suggested change
| - fanciness: **+f**[level]: Get a “fancy” rose, and optionally specify the | |
| level of fanciness. Level 1 draws the two principal E-W, N-S orientations, | |
| 2 adds the two intermediate NW-SE and NE-SW orientations, while 3 adds | |
| the eight minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and ENE-WSW | |
| [default is 1]. | |
| - fanciness: **+f**[level]: Get a "fancy" rose, and optionally specify the | |
| level of fanciness. | |
| - ``"1"``: Draws the two principal E-W, N-S orientations`. | |
| - ``"2"``: Adds the two intermediate NW-SE and NE-SW orientations. | |
| - ``"3"``: Adds the four minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and ENE-WSW. | |
| [Default is ``"1"``]. |
| - fanciness: **+f**[level]: Get a “fancy” rose, and optionally specify the | ||
| level of fanciness. Level 1 draws the two principal E-W, N-S orientations, | ||
| 2 adds the two intermediate NW-SE and NE-SW orientations, while 3 adds | ||
| the eight minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and ENE-WSW |
There was a problem hiding this comment.
Hm, I think to be consistent with "two pricipal orientations", it should be "four minor orientations".
Suggested change
| the eight minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and ENE-WSW | |
| the four minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and ENE-WSW |
Comment on lines
+34
to
+35
| - label: **+l**[w,e,s,n]: Label the cardinal points W,E,S,N. Optionally, | ||
| append your own four comma-separated strings to override the default. |
There was a problem hiding this comment.
Suggested change
| - label: **+l**[w,e,s,n]: Label the cardinal points W,E,S,N. Optionally, | |
| append your own four comma-separated strings to override the default. | |
| - label: **+l**\[w,e,s,n]: Label the cardinal points W,E,S,N. Optionally, | |
| append your own four labels as comma-separated strings to override the default. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code