add_inset_hrd

tulips.tulips.add_inset_hrd(m, time_index=100, ax=None, axins=None, fraction='20%', indices=None, loc='lower left', bbox_to_anchor=None, show_hrd_ticks_and_labels=False)[source]

Add inset HRD.

Add an inset HRD to a plot that highlights the current time-step.

Parameters
mmesaPlot object
axaxis object
indicesNone, list or ndarray

Selected indices for plotting

fractionstring

Fraction of the parent axis used for setting the size of the inset

axinsNone or Axes

If provided, inset axis to use.

time_indexint

Time index to highlight on inset plot.

locstr or int

Matplotlib location to put the inset axis on the parent axis.

bbox_to_anchortuple (x, y, width, height)

Bounding box for the axis

show_hrd_ticks_and_labelsBoolean

If set, display the axis ticks and labels of the inset HRD

Returns
——-
(axins, point): Axes

Created inset axis, and the point moving on the plot.