housing_distribution_model

class pyrecodes.resource_distribution_model.housing_distribution_model.HousingDistributionModel(resource_name: str, resource_parameters: dict, components: list[Component])

Bases: AbstractResourceDistributionModel

Class to distribute housing resources in the system.

This class checks whether people living in a house can keep living there - it compares a house’s supply of housing with its demand for housing.

Does not account for temporary shelter or distribution of people between houses.

distribute(time_step: int) → None

distribute_housing_within_component(component: Component) → None

get_total_consumption(scope: str) → float

get_total_demand(scope: str) → float

get_total_supply(scope: str) → float