ADCS.helpers.plot.plot module

ADCS.helpers.plot.plot.plot(sim, *subplots, layout=None, figsize=(10, 8), title=None, sharex=True)[source]

Render one or more subplot objects into a single matplotlib figure.

This function provides a lightweight wrapper that arranges multiple :class:~ADCS.helpers.plot.subplot.Subplot instances into a shared figure using a specified layout. It is intended as the main user-facing entry point for generating simulation result plots.

Parameters:

  • sim (:class:~ADCS.helpers.simresults.SimulationResults or :class:~ADCS.helpers.simresults_mc.MCSimulationResults) – Simulation results object supplying the data to all subplots.

  • subplots (:class:~ADCS.helpers.plot.subplot.Subplot) – One or more subplot objects to be rendered in the figure.

  • layout (tuple[int, int] or None) – Tuple specifying the matplotlib subplot grid as (rows, columns). If None, a vertical layout is chosen automatically.

  • figsize (tuple[float, float]) – Size of the matplotlib figure in inches.

  • title (str or None) – Optional figure-level title.

  • sharex (bool) – If True, all subplots share the same x-axis.

Returns:

None

Return type:

None