reVX.exclusions.setbacks.regulations.select_setback_regulations

select_setback_regulations(regulations_fpath=None, multiplier=None, generic_setback_dist=None, system_config=None)[source]

Select appropriate setback regulations based on input.

Parameters:

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 contains labels for the type of setback that each row represents, Value Type, which specifies whether the value is a multiplier or static height, Value, which specifies the numeric value of the setback or multiplier, and FIPS, which specifies a unique 5-digit code for each county (this can be an integer - no leading zeros required). Valid options for the Value Type are (case-insensitive; dashes, underscores, and spaces are interchangeable):
- “Structure Height Multiplier”
- “Meters”
If this input is None, a generic setback of generic_setback_dist * multiplier is used. By default None.
multiplier (int | float | str | None, optional) – A setback multiplier to use if regulations are not supplied. This multiplier will be applied to the generic_setback_dist to calculate the setback. If supplied along with regulations_fpath, this input will be used to apply a setback to all counties not listed in the regulations file. By default None.
generic_setback_dist (float | int | None) – Optional generic fallback setback distance. This can be used together with system_config so that local ordinances resolve against technology-specific values while the generic fallback uses a separate base distance.
system_config (dict | None) – Optional nested system configuration. Wind inputs use hub_height and rotor_diameter, which are be used to compute setbacks based on those individual quantities as well as the max-tip-height. Solar inputs use pv_system_height, which is used to compute height-based setbacks.

Returns:

Regulations – A regulations object that can be used to calculate the requested setback distance.