Figure.barb: Plot wind barbs in 2-D and 3-D

[yvonnefroehlich]

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

Example

input data: barbs_strength.txt, barbs_direction.txt

import pygmt

pen_barb = "0.5p,darkorange"
fill_barb = "brown"

fig = pygmt.Figure()
fig.basemap(region=[-5, 5] * 2, projection="X10c", frame=0)

for barbs_data, use_word in zip(
    ["barbs_strength.txt", "barbs_direction.txt"], [1, 0]
):
    with pygmt.clib.Session() as session:
        session.call_module(
            'barb',
            '{} \
            -W{} \
            -G{} \
            -Q{}' \
            .format(barbs_data, pen_barb, fill_barb, '0.5c')
        )
    fig.text(barbs_data, offset="0c/-0.05c", justify="TC", font="5p", use_word=use_word)
fig.show()

Documentation

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

GMT Option Flags and Modifieres

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

• -R: region #XXX
• -J: projection #XXX
• -B: frame
• -G: fill
• -W: pen
• -Q:
• -C: cmap
• -D:
• -I:
• -N: no_clip
• -U: Use Figure.timestamp instead.
• -X/-Y: Use Figure.shift_origin instead.
• --PAR=value: Use pygmt.config instead.

Notes on Input Formats

Add any notes on the input formats, especially the meaning of columns.

Linked Pull Requests

• Initial feature implementation #XXX
• Add a tutorial or gallery example

Related Issues and Discussions

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