run_pyHA

Functions:

command_line_pyH2A(input_file, output_dir)	Wrapper function to run pyH2A using click.
run_pyH2A()	Wrapper function to run pyH2A from the command line.

Classes:

pyH2A(input_file, output_directory[, print_info])

pyH2A class that performs discounted cash flow analysis and executes analysis modules.

pyH2A.run_pyH2A.command_line_pyH2A(input_file, output_dir)

Wrapper function to run pyH2A using click.

class pyH2A.run_pyH2A.pyH2A(input_file, output_directory, print_info=False)

pyH2A class that performs discounted cash flow analysis and executes analysis modules.

Parameters

input_filestr

Path to input file.

output_directorystr

Path to output file.

print_infobool, optional

Flag to control if detailed information during run of pyH2A is printed.

Returns

pyH2Aobject

pyH2A class object.

Attributes

inpdict

Dictionary containing input information and all information from discounted cash flow analysis.

base_caseDiscounted_Cash_Flow object

Discounted_Cash_Flow object for base case defined in input file with corresponding attributes.

meta_modulesdict

Dictionary containing class instances of executes analysis modules.

Methods:

check_for_plotting_method(method_name)	Returns true if a plotting indicator substring is in method_name.
execute_meta_module(module_name, meta_dict)	Requested module class is executed.
execute_module_methods(module, key, ...)	Requested methods of module class are executed.
get_arguments(table)	Arguments are read from the table in self.inp referenced in table['Arguments'] or directly read from table['Arguments']
meta_workflow(meta_dict)	Meta modules (analysis modules) are identified and executed

check_for_plotting_method(method_name)

Returns true if a plotting indicator substring is in method_name.

execute_meta_module(module_name, meta_dict)

Requested module class is executed.

execute_module_methods(module, key, module_name, meta_dict)

Requested methods of module class are executed.

get_arguments(table)

Arguments are read from the table in self.inp referenced in table[‘Arguments’] or directly read from table[‘Arguments’]

meta_workflow(meta_dict)

Meta modules (analysis modules) are identified and executed

Notes

Naming convention for analysis module: in self.inp, the table title has to contain Analysis and the last part of the string (seperated by spaces) has to be the module name

pyH2A.run_pyH2A.run_pyH2A()

Wrapper function to run pyH2A from the command line.