pygmt.grdpaste: Join two grids along their common edge

[Chuan1937]

This issue serves as the central place for discussing and tracking the implementation of the pygmt.grdpaste function 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/grdpaste.html
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/grdpaste
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.grdpaste.html

GMT Option Flags and Modifiers

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

• grid1/grid2
• -G: outgrid
• -S: Print a code number. Make no sense in PyGMT.
• -V[level]: Use verbose parameter instead
• -f[i|o]colinfo: Specify data types of input and/or output columns(Wrap grdpaste for joining two grids along their common edge #4399)
• --PAR=value: Use pygmt.config() instead

Notes on the input/output

grid1	grid2	outgrid	Notes
file	file	file	Works
file	file	xarray	Works
xarray	xarray	xarray	Works (requires GMT > 6.6.0)
xarray	xarray	file	Works (requires GMT > 6.6.0)
file	xarray	xarray	Fails with GMT_GRID_READ_ERROR. [Not supported]
file	xarray	file	Fails with GMT_GRID_READ_ERROR [Not supported]
xarray	file	xarray	Works [Not supported yet]
xarray	file	file	Works [Not supported yet]

Linked Pull Requests

• Initial feature implementation(Wrap grdpaste for joining two grids along their common edge #4399)
• Add unit tests(Wrap grdpaste for joining two grids along their common edge #4399)
• Add a tutorial or gallery example(Wrap grdpaste for joining two grids along their common edge #4399)

Related Issues and Discussions

[github-actions]

👋 Thanks for opening your first issue here!

Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our contributing guidelines and code of conduct.

[Chuan1937]

@seisman
How to modify it?

[seisman]

I think only maintainers can update the Project board. I've updated it. Let me know if you'd like to work on this wrapper.

[Chuan1937]

It doesn't seem convenient for non-maintainers to do this, so I'll tackle the other issues first

[seisman]

Non-maintainers can't update the Project board, but can do anything else like submitting PRs or discussing the implementation details.

Re-open it to track the progress.