abstract_resource_distribution_model

class pyrecodes.resource_distribution_model.abstract_resource_distribution_model.AbstractResourceDistributionModel

Bases: ResourceDistributionModel

Abstract class for the Resource Distribution Model.

abstract distribute(time_step: int) → None

distribute_at_this_time_step(time_step: int) → bool

Check whether to run resource distribution at a time step.

True if time step is in the distribution_time_steps list or if the list is empty - this implies that it was not specified by the user and the resource is distributed at each time step by default.

get_scope(scope='All') → list

Get the scope of the ReCoDeS Resilience Calculator to get total supply and demand.

Scope can be ‘All’, icnluding all components, or ‘Locality X’, including only components in the locality, where X is the locality number.

abstract get_total_consumption(scope: str) → float

abstract get_total_demand(scope: str) → float

abstract get_total_supply(scope: str) → float

set_distribution_time_steps(distribution_time_steps: list) → None