onstove.OnStove.run#

OnStove.run(technologies: list[str] | str = 'all', restriction: bool = True)#

Runs the model using the defined technologies as options to cook with.

It loops through the technologies and calculates all costs, benefit and the net-benefit of cooking with such technology relative to the current situation in every grid cell of the study area. Then, it calls the maximum_net_benefit() method to get the technology with highest net-benefit in each cell (and saves it in the max_benefit_tech column of the gdf). Finally, it extracts indicators such as lives saved, time saved, avoided emissions, health costs saved, opportunity cost gained, investment costs, fuel costs, and O&M costs.

Parameters:
technologies: str or list of str, default ‘all’

List of technologies to use for the analysis. If ‘all’ all technologies inside the techs attribute would be used. If a list of technology names is passed, then those technologies only will be used.

Note

All technology names passed need to match the names of technologies in the techs dictionary.

restriction: bool, default True

Whether to have the restriction to only select technologies that produce a positive benefit compared to the baseline.

See also
—–
maximum_net_benefit
extract_lives_saved
extract_health_costs_saved
extract_time_saved
extract_opportunity_cost
extract_reduced_emissions
extract_emissions_costs_saved
extract_investment_costs
extract_fuel_costs
extract_om_costs
extract_salvage