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

Documentation

• GMT: https://docs.generic-mapping-tools.org/dev/grdview.html
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/grdview
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.Figure.grdview.html

GMT Option Flags and Modifieres

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

• ingrid: grid
• -R: region
• -J: projection
• -Jz: zscale/zsize
• -B: frame
• -C: cmap Figure.grdview: Migrate cmap alias to the new alias system #4443
• -G: drape_grid Figure.grdview: Migrate the 'drapegrid' parameter to the new alias system #4442
• -I
• -N: plane/facade_fill Figure.grdview: Improve parameters plane/facade_fill/facade_pen to set the plane and facade #4235 @seisman
• -Q: surftype/dpi/meshfill/nan_transparent/monochrome Figure.grdview: Add parameters surftype/dpi/mesh_fill/nan_transparent/monochrome to control surface types #4234 @seisman
• -S: smooth Figure.grdview: Add alias "smooth" for the -S option #4444
• -T Figure.grdview, Figure.grdimage: Add alias "no_interpolation" for "-T" #3355
• -U: Use Figure.timestamp instead.
• -V: verbose
• -W:
  • -Wc: contour_pen
  • -Wf: facade_pen Figure.grdview: Improve parameters plane/facade_fill/facade_pen to set the plane and facade #4235 @seisman
  • -Wm: mesh_pen Figure.grdview: Add parameters surftype/dpi/mesh_fill/nan_transparent/monochrome to control surface types #4234
• -X/-Y: Use Figure.shift_origin instead.
• -f
• -b
• -p
• -t
• --PAR=value: Use pygmt.config instead.

Linked Pull Requests

• Initial feature implementation Wrap grdview #330 @weiji14
• Add a tutorial or gallery example

Related Issues and Discussions

Add links to related wrapper discussions, API design threads, or upstream GMT changes here.