reVX.utilities.regulations.AbstractBaseRegulations

class AbstractBaseRegulations(generic_regulation_value=None, regulations_fpath=None)[source]

Bases: ABC

ABC for county regulation values.

Parameters:

generic_regulation_value (float | int | None, optional) – A generic regulation value to be applied where local regulations and/or ordinances are not given. A None value signifies that no regulation should be applied for regions without a local regulation. By default None.
regulations_fpath (str | None, optional) – Path to regulations .csv or .gpkg file. At a minimum, this file must contain the following columns: Feature Type which labels the type of regulation that each row represents, Value Type, which specifies the type of the value (e.g. a multiplier or static height, etc.), Value, which specifies the numeric value of the regulation, and either FIPS, which specifies a unique 5-digit code for each county (this can be an integer - no leading zeros required), or a geometry column containing the spatial extent for each row. A None value signifies that no local regulations should be applied. By default None.

Methods

Attributes

`df`	Regulations table.
`generic`	Regulation value used for global regulations.
`generic_exists`	Flag indicating wether generic regulations exist.
`geometry_provided`	`True` if the input regulations include geometries.
`locals_exist`	Flag indicating wether local regulations exist.
`required_columns`	Required columns for regulations DataFrame.

property generic

Regulation value used for global regulations.

property df

Regulations table.

property geometry_provided

True if the input regulations include geometries.

property required_columns

Required columns for regulations DataFrame.

property locals_exist

Flag indicating wether local regulations exist.

property generic_exists

Flag indicating wether generic regulations exist.