reVX.turbine_flicker.regulations.FlickerRegulations

class FlickerRegulations(hub_height, rotor_diameter, flicker_threshold=None, regulations_fpath=None)[source]

Shadow flicker regulation values.

Parameters:

hub_height (float | int) – Turbine hub height (m).
rotor_diameter (float | int) – Turbine rotor diameter (m).
flicker_threshold (float | int, optional) – Maximum number of allowable flicker hours per year to use for generic flicker regulations. If None, then only local (county) flicker regulations are applied. By default, None.
regulations_fpath (str, 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 (flicker regulations must be called “Shadow Flicker”), Value Type, which specifies the type of the value (flicker value types must be “Hrs/Year”), Value, which specifies the numeric value of the flicker threshold (in hours), and FIPS, which specifies a unique 5-digit code for each county (this can be an integer - no leading zeros required). If this input is None, generic flicker regulations defined by flicker_threshold are 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.
`hub_height`	Turbine hub height in meters.
`locals_exist`	Flag indicating wether local regulations exist.
`required_columns`	Required columns for regulations DataFrame.
`rotor_diameter`	Turbine rotor diameter in meters.

property hub_height

Turbine hub height in meters.

property rotor_diameter

Turbine rotor diameter in meters.

property df

Regulations table.

property generic

Regulation value used for global regulations.

property generic_exists

Flag indicating wether generic regulations exist.

property geometry_provided

True if the input regulations include geometries.

property locals_exist

Flag indicating wether local regulations exist.

property required_columns

Required columns for regulations DataFrame.