CADETProcess.solution.SolutionVolume.plot

CADETProcess.solution.SolutionVolume.plot#

SolutionVolume.plot(start: float | None = None, end: float | None = None, x_axis_in_minutes: bool | None = True, y_axis_in_liters: bool | None = True, ylim: tuple[float, float] | None = None, update_layout: bool = True, ax: Axes | tuple[Axes] | None = None, setup_figure_kwargs: dict | None = None) tuple[Figure, Axes][source]#

Plot the volume over time.

Parameters:
startfloat | None, optional, default=None

Start time for plotting in seconds. If None, the first data point is used.

endfloat | None, optional, default=None

End time for plotting in seconds. If None, the last data point is used.

x_axis_in_minutesbool, optional, default=True

If True, the x-axis will be plotted using minutes.

y_axis_in_litersbool, optional, default=True

If True, the y-axis is displayed in Liters instead of m³.

ylimtuple[float, float] | None, default=None

Y-axis limits.

update_layoutbool, optional, default=True

If True, update layout.

axplt.Axes | tuple[plt.Axes] | None, default=None

Optional Matplotlib Axes. If not provided, a new figure is created.

setup_figure_kwargsdict | None, default=None

Additional options to setup the figure.

Returns:
tuple[plt.Figure, plt.Axes | tuple[plt.Axes]]

The Matplotlib Figure and Axes objects.