Comparative_MC_Analysis

Classes:

Comparative_MC_Analysis(input_file)

Comparison of Monte Carlo analysis results for different models.

class pyH2A.Analysis.Comparative_MC_Analysis.Comparative_MC_Analysis(input_file)

Comparison of Monte Carlo analysis results for different models.

Parameters

Comparative_MC_Analysis > […] > Valuestr

Path to input file for model.

Comparative_MC_Analysis > […] > Imagestr, optional

Path to image for model.

Notes

First column of Comparative_MC_Analysis table can include arbitrary name for model.

Methods:

check_target_price_range_consistency()	Check that the same target price ranges are specified for all models which are to be compared.
get_models()	Get models which are to be compared from Comparative_MC_Analysis table in input file and perform Monte Carlo analysis for them.
plot_combined_distance([fig_width, ...])	Plot combining development distance histogram and distance/H2 cost relationship.
plot_comparative_distance_cost_relationship([...])	Plot comparative development distance/H2 cost relationship.
plot_comparative_distance_histogram([ax, ...])	Plot comparative development distance histogram.

check_target_price_range_consistency()

Check that the same target price ranges are specified for all models which are to be compared.

get_models()

Get models which are to be compared from Comparative_MC_Analysis table in input file and perform Monte Carlo analysis for them.

plot_combined_distance(fig_width=12, fig_height=2, table_kwargs={}, image_kwargs={}, plot_kwargs={}, dist_kwargs={}, hist_kwargs={}, **kwargs)

Plot combining development distance histogram and distance/H2 cost relationship.

Parameters

fig_widthfloat, optional

Width of figure in inches.

fig_heightfloat, optional

Height of figure per model in inches.

target_linefloat, optional

y axis coordinate of target price line.

table_kwargsdict, optional

Dictionary containing optional keyword arguments for render_parameter_table()

image_kwargs: dict, optional

Dictionary containing optional keyword arguments for insert_image()

plot_kwargs: dict, optional

Dictionary containing optional keyword arguments for Figure_Lean(), has priority over **kwargs.

dist_kwargs: dict, optional

Dictionary containg optional keyword arguments for plot_distance_cost_relationship()

hist_kwargs: dict, optional

Dictionary containg optional keyword arguments for plot_distance_histogram()

**kwargs:

Additional kwargs passed to Figure_Lean()

Returns

figurematplotlib.fig or None

matplotlib.fig is returned if figure_lean is True.

plot_comparative_distance_cost_relationship(ax=None, figure_lean=True, table_kwargs={}, image_kwargs={}, plot_kwargs={}, dist_kwargs={}, **kwargs)

Plot comparative development distance/H2 cost relationship.

Parameters

axmatplotlib.axes, optional

Axes object in which plot is drawn. Default is None, creating new plot.

figure_leanbool, optional

If figure_lean is True, matplotlib.fig object is returned.

table_kwargsdict, optional

Dictionary containing optional keyword arguments for render_parameter_table()

image_kwargs: dict, optional

Dictionary containing optional keyword arguments for insert_image()

plot_kwargs: dict, optional

Dictionary containing optional keyword arguments for Figure_Lean(), has priority over **kwargs.

dist_kwargs: dict, optional

Dictionary containg optional keyword arguments for plot_distance_cost_relationship()

**kwargs:

Additional kwargs passed to Figure_Lean()

Returns

figureFigure_Lean object

Figure_Lean object is returned.

plot_comparative_distance_histogram(ax=None, figure_lean=True, table_kwargs={}, image_kwargs={}, plot_kwargs={}, hist_kwargs={}, **kwargs)

Plot comparative development distance histogram.

Parameters

axmatplotlib.axes, optional

Axes object in which plot is drawn. Default is None, creating new plot.

figure_leanbool, optional

If figure_lean is True, matplotlib.fig object is returned.

table_kwargsdict, optional

Dictionary containing optional keyword arguments for render_parameter_table()

image_kwargs: dict, optional

Dictionary containing optional keyword arguments for insert_image()

plot_kwargs: dict, optional

Dictionary containing optional keyword arguments for Figure_Lean(), has priority over **kwargs.

hist_kwargs: dict, optional

Dictionary containg optional keyword arguments for plot_distance_histogram()

**kwargs:

Additional kwargs passed to Figure_Lean()

Returns

figurematplotlib.fig or None

matplotlib.fig is returned if figure_lean is True.