pybop.plotting.plot_dataset

Functions

plot_dataset(dataset[, signal, trace_names, show])

Quickly plot a PyBOP Dataset using Plotly.

Module Contents

pybop.plotting.plot_dataset.plot_dataset(dataset, signal=['Voltage [V]'], trace_names=None, show=True, **layout_kwargs)

Quickly plot a PyBOP Dataset using Plotly.

Parameters:

• dataset (object) – A PyBOP dataset.

• signal (list or str, optional) – The name of the time series to plot (default: “Voltage [V]”).

• trace_names (list or str, optional) – Name(s) for the trace(s) (default: “Data”).

• show (bool, optional) – If True, the figure is shown upon creation (default: True).

• **layout_kwargs (optional) – Valid Plotly layout keys and their values, e.g. xaxis_title=”Time / s” or xaxis={“title”: “Time / s”, “titlefont_size”: 18}.

Returns:

The Plotly figure object for the scatter plot.

Return type:

plotly.graph_objs.Figure