-
Notifications
You must be signed in to change notification settings - Fork 229
Add Figure.directional_rose to plot a directional rose on map #4025
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
a46dc2c
to
59f2b18
Compare
pygmt/src/directional_rose.py
Outdated
- ``position_type="justify"``: *position* is given as a two-character | ||
justification code, meaning the anchor point of the rose is inside the map | ||
bounding box. | ||
- ``position_type="mirror"``: *position* is given as a two-character | ||
justification code, but the rose is outside the map bounding box. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm. I am not sure if "justify" and "mirror" are suitable / understandable terms here, especially "mirror" appears a bit strange for me. Is this orientated on some other implementaiton or documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GMT uses long names like mapcoords
,inside
,outside
,boxcoords
,plotcoords
https://github.com/GenericMappingTools/gmt/blob/98a9b39c1a94ff23dba8dd89fca9fae367432303/src/longopt/psbasemap_inc.h#L30
but gmtlogo
uses user|map
,justify
,mirror
,normalize
,plot
https://github.com/GenericMappingTools/gmt/blob/98a9b39c1a94ff23dba8dd89fca9fae367432303/src/longopt/gmtlogo_inc.h#L29
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the parameters/arguments need more discussions.
2cc02fb
to
4b7b799
Compare
Description of proposed changes
This PR adds the
Figure.directional_rose
method to plot a map directional rose on map. It wraps thebasemap -Td
/coast -Td
options.The GMT CLI syntax:
The Pythonic long-forma parameters are:
labels
, sincelabel
is an alias for common option-l
?]Example
Preview: https://pygmt-dev--4025.org.readthedocs.build/en/4025/api/generated/pygmt.Figure.directional_rose.html
Addressing #2831. Related to #4010.
Reminders
make format
andmake check
to 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