Fix setting "sharex", "sharey", and "frame" of Figure.subplot in combination with Figure.basemap

[yvonnefroehlich]

Description of proposed changes

For context please see issue #2365

This PR aims to test the suggestion in comment #2365 (comment).

First PR #2418 has to be merged.

Fixes #2365

Reminders

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• Add new public functions/methods/classes to doc/api/index.rst.
• Write detailed docstrings for all functions/methods.
• If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
• If adding new functionality, add an example to docstrings or tutorials.
• Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

• /format: automatically format and lint the code
• /test-gmt-dev: run full tests on the latest GMT development version

[yvonnefroehlich]

/format

[yvonnefroehlich]

Based on this rough test I feel setting the x_share, y_share, and frame parameters via pygmt.Figure.subplot work now as expected.

Code example

import pygmt

nrows = 1
ncols = 2

fig = pygmt.Figure()

with fig.subplot(
    nrows=nrows,
    ncols=ncols,
    figsize=("10c", "5c"),
    sharex="b+llabel_x",  # at the bottom
    sharey="l+llabel_y",  # on the left side
    # annotations in steps of 5
    # ticks in steps of 0.5
    # gridlines in steps of 1
    frame="a5f0.5g1",
):

    for i in range(nrows):
        for j in range(ncols):
            index = i * nrows + j

            with fig.set_panel(panel=index):
                fig.basemap(region=[0, 10, 0, 10], projection="X?")

fig.show()
# fig.savefig(fname="issue_labels_doubleloop_NEW.png")

Output figure:

[seisman]

We automatically added -B option when required parameters are not given in c274463 (#1909). Obviously, it has some side effects. I think you can simply revert the changes in c274463 by running:

git revert c27446391ac6097e9610dbb41e750c4ba60f8e82

[github-actions]

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status	Path
added	pygmt/tests/baseline/test_basemap_subplot.png
deleted	pygmt/tests/baseline/test_basemap_required_args.png

Image diff(s)

Added images

• pygmt/tests/baseline/test_basemap_subplot.png

Modified images

Path	Old	New

Report last updated at commit e1ffbdb

[yvonnefroehlich]

We automatically added -B option when required parameters are not given in c274463 (#1909). Obviously, it has some side effects. I think you can simply revert the changes in c274463 by running:

git revert c27446391ac6097e9610dbb41e750c4ba60f8e82

Commit c274463 is reverted in commit 3aa1374.

[seisman]

Actually, in subplot mode, none of these options are required. For example, the first example in #2365 no longer works after this PR.

Ideally, we should check if it's in subplot mode, and these options are required only when it's NOT in subplot mode. However, currently we can't know it. So I believe we have to remove the checks, right?

[yvonnefroehlich]

Done in commit 8e9d4e5.

[yvonnefroehlich]

/format