How to do axis label sharing with geographic axis?

[gepcel]

How to do axis label sharing with geographic axis?

import ultraplot as pplt
fig, axs = pplt.subplots(ncols=2, nrows=2, projection='cyl', refwidth='5cm', share='all')
axs.format(lonlim=(0, 60), latlim=(-20, 20),
           lonlines=15, latlines=10, lonlabels='both', latlabels='both')

Like the code above, share='all' doesn't seems work.

[cvanelteren]

You're right—this isn't currently supported and would mainly make sense for rectilinear projects. That said, it’s definitely a feature we could consider adding. You can check out the relevant commit here: 2085c2f1. If you're interested, feel free to open a PR to kick things off!

[cvanelteren]

Thanks for the suggestion! I took a look, and to support this properly, the GeoAxis object would need some extended functionality for shared axes. That would involve patching in methods similar to those used by CartesianAxes, while also ensuring all projections involved are rectilinear (and the same). The patching would be possible relatively easily but requires proper testing and disproportionate use for a feature of which I think is rather niche (but do correct me when I am wrong).

Since this is a fairly niche use case, a quick workaround for now would be to manually disable the labels. I agree it's a worthwhile improvement, and I might revisit this when I have a bit more time to work on it -- otherwise I am willing to review pull requests in the mean time.

[cvanelteren]

Update:

Think I figured something out:

Still in a pretty rough state but it is getting somewhere. More to follow soon 👀

[cvanelteren]

@gepcel can you checkout #159

[cvanelteren]

🥳

[gepcel]

I'm not sure I did everything right. But I got an error.

In [1]: import ultraplot as pplt

In [2]: fig, axs = pplt.subplots(ncols=2, nrows=2, projection='cyl', refwidth='5cm', share='all')

In [3]: axs.format(lonlim=(0, 60), latlim=(-20, 20),
   ...:            lonlines=15, latlines=10, lonlabels='both', latlabels='both')
---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
Cell In[3], line 1
----> 1 axs.format(lonlim=(0, 60), latlim=(-20, 20),
      2            lonlines=15, latlines=10, lonlabels='both', latlabels='both')

File ~\Downloads\ultraplot-feat-shared-geo-new\ultraplot\gridspec.py:1630, in SubplotGrid.format(self, **kwargs)
   1600 @docstring._snippet_manager
   1601 def format(self, **kwargs):
   1602     """
   1603     Call the ``format`` command for the `~SubplotGrid.figure`
   1604     and every axes in the grid.
   (...)   1628     ultraplot.config.Configurator.context
   1629     """
-> 1630     self.figure.format(axs=self, **kwargs)

File ~\Downloads\ultraplot-feat-shared-geo-new\ultraplot\internals\warnings.py:118, in _rename_kwargs.<locals>._decorator.<locals>._deprecate_kwargs_wrapper(*args, **kwargs)
    113         key_new = key_new.format(value)
    114     _warn_ultraplot(
    115         f"Keyword {key_old!r} was deprecated in version {version} and may "
    116         f"be removed in {next_release()}. Please use {key_new!r} instead."
    117     )
--> 118 return func_orig(*args, **kwargs)

File ~\Downloads\ultraplot-feat-shared-geo-new\ultraplot\figure.py:1694, in Figure.format(self, axs, figtitle, suptitle, suptitle_kw, llabels, leftlabels, leftlabels_kw, rlabels, rightlabels, rightlabels_kw, blabels, bottomlabels, bottomlabels_kw, tlabels, toplabels, toplabels_kw, rowlabels, collabels, includepanels, **kwargs)
   1687 for ax in axs:
   1688     kw = {
   1689         key: value
   1690         for cls, kw in kws.items()
   1691         for key, value in kw.items()
   1692         if isinstance(ax, cls) and not classes.add(cls)
   1693     }
-> 1694     ax.format(rc_kw=rc_kw, rc_mode=rc_mode, skip_figure=True, **kw, **kwargs)
   1696 # Warn unused keyword argument(s)
   1697 kw = {
   1698     key: value
   1699     for name in kws.keys() - classes
   1700     for key, value in kws[name].items()
   1701 }

File ~\Downloads\ultraplot-feat-shared-geo-new\ultraplot\axes\geo.py:884, in GeoAxes.format(self, extent, round, lonlim, latlim, boundinglat, longrid, latgrid, longridminor, latgridminor, ticklen, lonticklen, latticklen, latmax, nsteps, lonlocator, lonlines, latlocator, latlines, lonminorlocator, lonminorlines, latminorlocator, latminorlines, lonlocator_kw, lonlines_kw, latlocator_kw, latlines_kw, lonminorlocator_kw, lonminorlines_kw, latminorlocator_kw, latminorlines_kw, lonformatter, latformatter, lonformatter_kw, latformatter_kw, labels, latlabels, lonlabels, rotatelabels, loninline, latinline, inlinelabels, dms, labelpad, labelcolor, labelsize, labelweight, **kwargs)
    882 latlabels = _not_none(latlabels, labels)
    883 # Set the ticks
--> 884 self._toggle_ticks(lonlabels, "x")
    885 self._toggle_ticks(latlabels, "y")
    886 lonarray = self._to_label_array(lonlabels, lon=True)

File ~\Downloads\ultraplot-feat-shared-geo-new\ultraplot\axes\geo.py:596, in GeoAxes._toggle_ticks(self, label, which)
    594 case "all" | "both":
    595     if which == "x":
--> 596         self.xaxis.set_position("both")
    597     else:
    598         self.yaxis.set_position("both")

AttributeError: 'XAxis' object has no attribute 'set_position'

[cvanelteren]

Yes my bad I need to change the typo

[cvanelteren]

@gepcel fixed the typos. Should be good now I think. hold on, both sides are not behaving correctly, the others are fine. Edit 2: Actually try it, not sure if this is what you wanted or you want the inner labels to turn off too

[cvanelteren]

There are still some bugs to figure with the automatic sharing. I will try to limit some.

[cvanelteren]

Note to self: A few things need to happen.

• Axes are automatically shared in UltraPlot. The checks needs to be expanded such that it turns off the sharing when the sharing won't be possible. In principle mixing cartopy and basemap should work fine for rectilinear projections but there are some quirks that still exist in this context
• Constructively building a figure such as in test_geographic_multiple_projections will fail unless sharing is explicitly turned off which is not nice from a user experience.

[cvanelteren]

We could also just turn off sharing by default; which would be the easiest fix I guess.

[gepcel]

What should axis sharing do when it's on both sides? For example with a single axes, yticklabel is shown on both left and right sides.

fig, ax = pplt.subplot(refwidth='3cm')
ax.format(yticklabelloc='both')
pplt.show()

And with subplots, the first axis gets yticklabel on both left and right sides, but the second gets no yticklabels.

fig, ax = pplt.subplots(ncols=2, refwidth='3cm', share='all')
ax.format(yticklabelloc='both')
pplt.show()

And this holds for geoaxes, too. With subplots, both subplots get latlabels on both left and right sides.

fig, ax = pplt.subplots(ncols=2, refwidth='3cm', proj='cyl',share='all')
ax.format(latlabels='both')
pplt.show()

I may be wrong, but I'm expecting something like: