ahkab.plotting

This module offers the functions needed to plot the results of a simulation.

It is only functional if matplotlib is installed.

Module reference

plot_results(title, y2y1_list, results, outfilename=None)

Plot the results.

Parameters:

title : string

The plot title

y2y1_list : list

A list of tuples. Each tuple has to be in the format (y2, y1). Each member of the tuple has to be a valid identifier. You can check the possible voltage and current identifiers in the result set calling res.keys(), where res is a solution object.

result : solution object or derivate

The results to be plotted.

outfilename : string, optional

The filename of the output file. If left unset, the plot will not be written to disk. The format is set through options.plotting_outtype.

Returns:

None.

save_figure(filename, fig=None)

Apply the figure options for saving and then save the supplied figure to filename.

The format of the output figure is set by options.plotting_outtype.

Parameters:

filename : string

The output filename.

fig : figure object, optional

The figure to be saved.

Returns:

None.

show_plots()

See the fruit of your work!