polartoolkit.subplots

Contents

polartoolkit.subplots#

subplots(grids, hemisphere=None, epsg=None, region=None, dims=None, fig_title=None, fig_x_axis_title=None, fig_y_axis_title=None, fig_title_font='30p,Helvetica-Bold', subplot_labels=True, subplot_labels_loc='TL', row_titles=None, column_titles=None, **kwargs)[source]#

Plot a series of grids as individual suplots. This will automatically configure the layout to be closest to a square. Add any parameters from plot_grid() here as keyword arguments for further customization.

Parameters:

  • grids (list) – list of xarray.DataArray’s to be plotted

  • hemisphere (str, optional) – set whether to plot in “north” hemisphere (EPSG:3413) or “south” hemisphere (EPSG:3031), can be set manually, or will read from the environment variable: “POLARTOOLKIT_HEMISPHERE”

  • epsg (str | None, optional) – set which EPSG projection to use for plotting, can be set manually, or will read from the environment variable: “POLARTOOLKIT_EPSG”, by default None

  • region (tuple[float, float, float, float], optional) – choose to subset the grids to a specified region, in format [xmin, xmax, ymin, ymax], by default None

  • dims (tuple, optional) – customize the subplot dimensions (# rows, # columns), by default will use square_subplots() to make a square(~ish) layout.

  • fig_title (str, optional) – add a title to the figure, by default None

  • fig_x_axis_title (str, optional) – add a title to the x axis of the figure, by default None

  • fig_y_axis_title (str, optional) – add a title to the y axis of the figure, by default None

  • fig_title_font (str, optional) – font for the figure title, by default “30p,Helvetica-Bold”

  • subplot_labels (bool, optional) – add subplot labels (a, b, c …), by default True

  • subplot_labels_loc (str, optional) – location of subplot labels, by default “TL”

  • row_titles (list, optional) – add titles to the left of each row, by default None

  • column_titles (list, optional) – add titles above each column, by default None

  • kwargs (Any)

Returns:

Returns a figure object, which can be used by other PyGMT plotting functions.

Return type:

pygmt.Figure

Contents