voyagerpy.plotting.plot.subplots_single_colorbar#

voyagerpy.plotting.plot.subplots_single_colorbar(nplot: int = 1, ncol: int = 1, cax_width: float = 0.2, cax_space: float = 0.4, **kwargs) → Tuple[Figure, ndarray[Any, dtype[Axes]], Axes]#

Create a figure with subplots and a single colorbar.

The figure will contain nplot subplots, arranged in ncol columns. The colorbar will be placed on the right.

Parameters:

  • nplot (int, optional) – The number of subplots to create, by default 1

  • ncol (int, optional) – The number of columns in the grid, by default 1

  • cax_width (float, optional) – The width of the colorbar axis, by default 0.2

  • cax_space (float, optional) – The space between the colorbar and the main grid, by default 0.4

Returns:

The matplotlib figure, the axes, and the colorbar axes.

Return type:

Tuple[Figure, npt.NDArray[Axes], Axes]