reVX.exclusions.max_height.regulations.validate_height_regulations_input

validate_height_regulations_input(system_height=None, hub_height=None, rotor_diameter=None, regulations_fpath=None, generic_height_limit=None)[source]

Validate the height regulations initialization input

Specifically, this function raises an error unless exactly one of the following combinations of inputs are provided:

  • system_height

  • hub_height and rotor_diameter

Parameters:

  • system_height (float | int) – Height of the system being considered. If this input is not None, then hub_height and rotor_diameter must both be None. 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 system height. 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 system height. By default, None.

  • regulations_fpath (str, optional) – Path to local regulations file. By default, None.

  • generic_height_limit (float | int, optional) – Generic maximum allowed system height in meters to apply everywhere outside jurisdictions with local regulations. By default, None.

Returns:

HeightRestrictionRegulations – A regulations object that can be used to determine where a system exceeds the height restriction.

Raises:

RuntimeError – If not enough info is provided (all inputs are None), or too much info is given (all inputs are not None).