object_model.benefit.Benefit

object_model.benefit.Benefit(self, data)

Object holding all attributes and methods related to a benefit analysis.

Methods

Name	Description
cba	Cost-benefit analysis for the whole study area.
cba_aggregation	Zonal Benefits analysis for the different aggregation areas.
check_scenarios	Check which scenarios are needed for this benefit calculation and if they have already been created.
has_run_check	Check if the benefit analysis has already been run.
ready_to_run	Check if all the required scenarios have already been run.
run_cost_benefit	Run the cost-benefit calculation for the total study area and the different aggregation levels.

object_model.benefit.Benefit.cba()

Cost-benefit analysis for the whole study area.

object_model.benefit.Benefit.cba_aggregation()

Zonal Benefits analysis for the different aggregation areas.

object_model.benefit.Benefit.check_scenarios()

Check which scenarios are needed for this benefit calculation and if they have already been created.

The scenarios attribute of the object is updated accordingly and the table of the scenarios is returned.

Name	Type	Description
	pd.DataFrame	a table with the scenarios of the Benefit analysis and their status

object_model.benefit.Benefit.has_run_check()

Check if the benefit analysis has already been run.

Name	Type	Description
	bool	True if the analysis has already been run, else False

object_model.benefit.Benefit.ready_to_run()

Check if all the required scenarios have already been run.

Name	Type	Description
	bool	True if required scenarios have been already run

object_model.benefit.Benefit.run_cost_benefit()

Run the cost-benefit calculation for the total study area and the different aggregation levels.