This issue serves as the central place for discussing and tracking the implementation of the Figure.directional_rose method in PyGMT. The issue will be closed when the initial implementation is complete. Progress is tracked at PyGMT: Wrapping GMT modules.

The Figure.directional_rose method wraps the -Td option in basemap/coast.

Documentation

• GMT: https://docs.generic-mapping-tools.org/dev/basemap.html
• GMT.jl: NA
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.Figure.directional_rose.html

GMT Option Flags

☑️: Implemented; ⬜: To be implemented/discussed; Strikethrough: Won't implement.

Below we list all option flags in basemap, but not all of them make sense here.

• -J:
• -R:
• -A: Dump the polygon. Makes no sense.
• -B:
• -F: box.
• -L: Will be implemented as Figure.scale_bar
• -Tm: Will be implemented as Figure.magnetic_rose
• -U: Use Figure.timestamp instead
• -V
• -X/-Y: Use Figure.shift_origin instead.
• -f: output column types. Makes no sense.
• -p
• -t
• --PAR=value: Use pygmt.config instead.
• -Td: -Td[g|j|J|n|x]refpoint[+f|F[level]][+jjustify][+l[w,e,s,n]][+odx[/dy]][+wwidth]
  • g|j|J|n|x: position_type
  • refpoint: position
  • +j: anchor
  • +o: anchor_offset
  • +w: width
  • +l: label [Maybe labels, since label is an alias for common option -l?]
  • +f: fancy
  • +F: not implemented yet

Linked Pull Requests

• Initial feature implementation Add Figure.directional_rose to plot a directional rose on map #4025 @seisman
• Add a tutorial or gallery example