Figure 1: Comparison of GMT and PyGMT syntax

[seisman]

This PR adds an image for comparing GMT and PyGMT syntax. The script is adapted from https://www.pygmt.org/dev/install.html#testing-your-install.

TODO:

• Implement the Figure.paragraph method Add Figure.paragraph to typeset one or multiple paragraph of text strings pygmt#3709

[gitnotebooks]

Found 1 changed notebook. Review the changes at https://app.gitnotebooks.com/GenericMappingTools/pygmt-paper-figures/pull/4

[seisman]

@yvonnefroehlich @weiji14 Any comments on this example?

[weiji14]

Debating on whether to keep the text the same for both, e.g. use something like text="ABCD", just to make the comparison more exact. Other than that, I think it's a fine example.

[seisman]

If the same text is prefered, we can use "GMT" in both.

[seisman]

If the same text is prefered, we can use "GMT" in both.

I've updated the example to use the same text "GMT" in both versions.

[yvonnefroehlich]

It looks like the "@" within red@75 is not included in the plotted text, event it is containted in the related strings.

[yvonnefroehlich]

I am wondering if we want to color the coresponding parts in the codes for GMT and PyGMT in the same colors; similar as we did it in the presentation for AGU last year; e.g., (colors can be discussed and adjusted):

Click for codes (but using `Figure.text` with a loop and `@@` for the @ sign in GMT):

import pygmt


# Sequence of strings for the GMT CLI code.
# The leading tab characters are intentional to match the indentation.
gmt_str = """


gmt begin GMT_map png
\tgmt @;gray50;basemap@;; @;blue;-JN15c@;; @;purple;-R0/360/-90/90@;; @;orange;-B@;;
\tgmt @;gray50;coast@;; @;tan;-Gtan@;; @;lightblue;-Slightblue@;;
\t@;magenta;echo GMT@;; | gmt @;gray50;text@;; @;red;-F+f80p,Helvetica-Bold,red@@75@;;@;brown;+cMC@;;
gmt end @;gray50;show@;;
""".splitlines()

# Sequence of strings for the PyGMT code.
pygmt_str = """
import pygmt

fig = pygmt.Figure()
fig.@;gray50;basemap@;;(@;blue;projection="N15c"@;;, @;purple;region=[0, 360, -90, 90]@;;, @;orange;frame=True@;;)
fig.@;gray50;coast@;;(@;tan;land="tan"@;;, @;lightblue;water="lightblue"@;;)
fig.@;gray50;text@;;(@;brown;position="MC"@;;, @;magenta;text="GMT"@;;, @;red;font="80p,Helvetica-Bold,red@@75@;;")
fig.@;gray50;show@;;()
fig.@;gray50;savefig@;;("PyGMT_map.png")
""".splitlines()

args_text = {"x": 0.25, "justify": "BL", "font": "Courier-Bold,6p"}


fig = pygmt.Figure()
pygmt.config(FONT_TITLE="10p", MAP_TITLE_OFFSET="4p")

fig.basemap(region=[0, 20, 0, 3], projection="X7.1/2c", frame="lrtb+tGMT CLI")
y = 3
for i in range(len(gmt_str)):
    fig.text(text=gmt_str[i], y=y, **args_text)
    y = y - 0.35

fig.shift_origin(xshift="w+0.1c")

fig.basemap(region=[0, 20, 0, 3], projection="X9/2c", frame="lrtb+tPyGMT")
y = 3
for i in range(len(pygmt_str)):
    fig.text(text=pygmt_str[i], y=y, **args_text)
    y = y - 0.35

fig.show()
fig.savefig("Fig1_PyGMT_GMT_comparison_color_atsign.png")

[seisman]

It looks like the "@" within `red@75` is not included in the plotted text, event it is containted in the related strings.

Nice catch. Need to use @@ when typesetting text strings.

[seisman]

I am wondering if we want to color the coresponding parts in the codes for GMT and PyGMT in the same colors; similar as we did it in the presentation for AGU last year; e.g., (colors can be discussed and adjusted):

I feel it makes the code a little too complicated. Unlike presentations, people usually have more time to read and compare the codes in the manuscript.

[yvonnefroehlich]

I am wondering if we want to color the coresponding parts in the codes for GMT and PyGMT in the same colors; similar as we did it in the presentation for AGU last year; e.g., (colors can be discussed and adjusted):

I feel it makes the code a little too complicated. Unlike presentations, people usually have more time to read and compare the codes in the manuscript.

Agree, the text strings get long and difficult to read with all the in-text color changes.

[seisman]

Perhaps we should merge these approved examples into the main branch? When new changes are needed, we can just open a separate PR so that we can focus on the changes.