matcal.core.plotting
This module contains base classes used for plotting. It also includes user facing functions for plotting and retrieving results from serialized archive files.
Functions
|
|
|
Makes a series of standardized plots based on the best parameter evaluation, and the evaluation history of the study. |
Classes
|
Class used to create automatic plots at the end of an evaluation set. |
- matcal.core.plotting.make_standard_plots(*independent_fields, show=True, block=True, plot_dir='user_plots', plot_id='best', plot_model_objectives=False, plot_exp_data=False, plot_sim_data=False) None[source]
Makes a series of standardized plots based on the best parameter evaluation, and the evaluation history of the study.
- Parameters:
independent_fields – Optional parameters to pass to specify the name of field to be used as the independent field for the purposes of plotting. Multiple field names can be passed if different data sets use different independent variables. Priority is given to fields specified earlier in the passed fields. If not passed an array of plots will be generated to cover all possible plotting combinations.
show (bool) – Specify where to show the plots
block (bool) – stops Python from executing code after the plot figure is created. Follow-on code will not execute until the figure is closed. Default is to block (e.g. block=True).
plot_dir (str) – specify a folder to output the plot files to
plot_id – evaluation id number to plot. Default is ‘best’ only other valid options are evaluation ids that have completed and have been saved.
plot_model_objectives (bool) – Plot the objectives versus parameter and evaluation indices for each model.
plot_exp_data (bool) – Plot the experimental data instead of the QoIs extracted from the data.
plot_sim_data (bool) – Plot the simulation data instead of the QoIs extracted from the data.