Buyout Decision

Buyout Decision#

Description

This analysis helps identify candidate properties for buyout and allows practitioners and researchers to evaluate the potential equity outcomes of their selection under different scenario events.

The outputs of this analysis is a CSV file with buildings to consider for buyout based on the set criteria. This can assist local practitioners to identify candidate properties for buyout selection and allows practitioners and researchers to evaluate the potential equity outcomes of their selection

Input parameters

key name	type	name	description
`result_name` ^*	`str`	Result name	Name of the result dataset.
`residential_archetypes` ^*	`list`	Residential archtetypes	Residential archetypes to consider for buyout.
`fema_buyout_cap` ^*	`float`	FEMA buyout cap	FEMA buyout cap is the maximum appraised value considered for buyout.

Input datasets

key name	type	name	description
`buildings` ^*	`ergo:buildingInventoryVer4` `ergo:buildingInventoryVer5` `ergo:buildingInventoryVer6` `ergo:buildingInventoryVer7`	Building dataset	A building dataset.
`past_building_damage` ^*	`ergo:buildingDamageVer6`	Previous Building damage	Building damage from a previous event.
`future_building_damage` ^*	`ergo:buildingDamageVer6`	Future/predicted Building damage	Building damage from a future/predicted event.
`housing_unit_allocation` ^*	`incore:housingUnitAllocation`	Housing unit allocation	Housing unit allocation.
`population_dislocation` ^*	`incore:popDislocation`	Population dislocation	Population dislocation results.

Output datasets

key name	type	parent key	name	description
`result` ^*	`incore:buyoutDecision`	`buildings`	Results	A dataset containing buyout decision results (format: CSV).

(* required)

Execution

code snippet:

    # Create buyout analysis
    buyout_decision = BuyoutDecision(client)

    # Load input datasets
    buyout_decision.load_remote_input_dataset("buildings", buildings_id)
    buyout_decision.load_remote_input_dataset("housing_unit_allocation", hua_id)
    buyout_decision.load_remote_input_dataset("past_building_damage", past_building_damage_id)
    buyout_decision.load_remote_input_dataset("future_building_damage", future_building_damage_id)
    buyout_decision.load_remote_input_dataset("population_dislocation", past_pop_dislocation_id)


    # Specify the result name
    result_name = "galveston_buyout_result"
    
    # Set analysis parameters
    buyout_decision.set_parameter("fema_buyout_cap", fema_buyout_cap)
    buyout_decision.set_parameter("residential_archetypes", residential_archetypes)
    buyout_decision.set_parameter("result_name", result_name)

    # Run buyout analysis
    buyout_decision.run_analysis()

full analysis: buyout_decision.ipynb