reVX.setbacks.regulations.select_setback_regulations

select_setback_regulations(base_setback_dist=None, hub_height=None, rotor_diameter=None, regulations_fpath=None, multiplier=None)[source]

Select appropriate setback regulations based on input.

Parameters:

  • base_setback_dist (float | int) – Base setback distance (m). This value will be used to calculate the setback distance when a multiplier is provided either via the regulations_fpath csv or the multiplier input. In these cases, the setbacks will be calculated using base_setback_dist * multiplier. By default, None.

  • hub_height (float | int) – Turbine hub height (m), used along with rotor diameter to compute blade tip-height which is used as the base setback distance. By default, None.

  • rotor_diameter (float | int) – Turbine rotor diameter (m), used along with hub height to compute blade tip-height which is used as the base setback distance. 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 contains labels for the type of setback that each row represents, Value Type, which specifies wether 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 base_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 base_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.

Returns:

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