voyagerpy.plotting.plot.configure_subplots#

voyagerpy.plotting.plot.configure_subplots(nplots: int, ncol: int | None = 2, **kwargs) → Tuple[Figure, ndarray[Any, dtype[Axes]]]#

Configure subplots for a given number of plots.

Create a figure with a grid of subplots, with the number of columns supplied. If layout is set to “tight”, then gridspec_kw is ignored.

Parameters:

  • nplots (int) – The number of plots to draw. Each plot will be drawn on a different axis.

  • ncol (Optional[int], optional) – The number of columns in the grid, by default 2.

  • **kwargs – Additional arguments to pass to matplotlib.pyplot.subplots().

Returns:

The figure and the axes.

Return type:

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