python_api_usage#

Attributes#

Classes#

NewUncertaintyResult

An impact model result is one, or a collection of tables and/or figures generated

Module Contents#

class python_api_usage.NewUncertaintyResult#

Bases: apparun.results.ImpactModelResult

An impact model result is one, or a collection of tables and/or figures generated by executing an impact model.

get_figure(table: pandas.DataFrame, save=True)#

Abstract method. Generate the output as a figures, or a collection of figures, using the output of the get_table method. :param table: tabular result data. :param save: also save the figure(s) on top of returning it :return: figure, or collection of figure generated.

get_table() pandas.DataFrame#

Abstract method. Generate the output as a table, or a collection of tables. :return: tabular results as a pandas DataFrame.

n: int#

Generate uncertainty for each node using Monte Carlo. Result figure as a boxplot.

python_api_usage.OUTPUT_FILES_PATH = 'outputs/'#
python_api_usage.impact_model#
python_api_usage.new_nodes_uncertainty_result#
python_api_usage.new_nodes_uncertainty_table#
python_api_usage.nodes_scores#
python_api_usage.sankey_result#
python_api_usage.sankey_table#
python_api_usage.scenario_comparison_result#
python_api_usage.scenario_comparison_table#
python_api_usage.scores#
python_api_usage.scores_by_phase#
python_api_usage.sobol_result#
python_api_usage.sobol_table#
python_api_usage.tree_map_result#
python_api_usage.tree_map_table#
python_api_usage.uncertainty_nodes_result#
python_api_usage.uncertainty_nodes_table#