Flicker refactor

reVX/cli.py

@@ -11,7 +11,7 @@
 from rex.utilities.utilities import safe_json_load
 
 from reVX.offshore.dist_to_ports_converter import DistToPortsConverter
-from reVX.utilities.exclusions_converter import ExclusionsConverter
+from reVX.utilities import ExclusionsConverter
 from reVX.utilities.forecasts import FcstUtils
 from reVX.utilities.output_extractor import output_extractor
 from reVX.utilities.region_classifier import RegionClassifier

reVX/config/setbacks.py

@@ -5,7 +5,7 @@
 import logging
 
 from reV.config.base_analysis_config import AnalysisConfig
-from reVX.setbacks.regulations import validate_regulations_input
+from reVX.setbacks.regulations import validate_setback_regulations_input
 from reVX.setbacks import SETBACKS
 
 logger = logging.getLogger(__name__)
@@ -22,9 +22,10 @@ def _preflight(self):
         Run a preflight check for extra requirements based on feature type.
         """
         super()._preflight()
-        validate_regulations_input(base_setback_dist=self.base_setback_dist,
-                                   hub_height=self.hub_height,
-                                   rotor_diameter=self.rotor_diameter)
+        validate_setback_regulations_input(
+            base_setback_dist=self.base_setback_dist,
+            hub_height=self.hub_height,
+            rotor_diameter=self.rotor_diameter)
 
     @property
     def feature_type(self):
@@ -88,3 +89,8 @@ def hsds(self):
     def weights_calculation_upscale_factor(self):
         """Get upscale factor for weights calculation. """
         return self.get("weights_calculation_upscale_factor", None)
+
+    @property
+    def out_layers(self):
+        """Get out_layers dictionary. """
+        return self.get("out_layers", None)

reVX/config/turbine_flicker.py

@@ -10,8 +10,7 @@ class TurbineFlickerConfig(AnalysisConfig):
     """Config framework for turbine flicker calculation"""
 
     NAME = 'TurbineFlicker'
-    REQUIREMENTS = ('excl_fpath', 'res_fpath', 'building_layer', 'hub_height',
-                    'rotor_diameter')
+    REQUIREMENTS = ('excl_fpath', 'res_fpath', 'hub_height', 'rotor_diameter')
 
     def __init__(self, config):
         """
@@ -23,8 +22,13 @@ def __init__(self, config):
         super().__init__(config)
         self._default_tm_dset = 'techmap_wtk'
         self._default_resolution = 128
+        self._default_grid_cell_size = 90
+        self._default_max_flicker_exclusion_range = "10x"
         self._default_building_threshold = 0
         self._default_flicker_threshold = 30
+        self._default_hsds_flag = False
+        validate_feature_input(features_path=self.features_path,
+                               building_layer=self.building_layer)
 
     @property
     def excl_fpath(self):
@@ -36,10 +40,20 @@ def res_fpath(self):
         """Get the resource .h5 file path (required)."""
         return self['res_fpath']
 
+    @property
+    def regs_fpath(self):
+        """Get regulations .csv path"""
+        return self.get('regs_fpath', None)
+
+    @property
+    def features_path(self):
+        """Get path to features file or directory (required)."""
+        return self.get('features_path', None)
+
     @property
     def building_layer(self):
         """Get the building layer name."""
-        return self['building_layer']
+        return self.get('building_layer', None)
 
     @property
     def hub_height(self):
@@ -65,6 +79,20 @@ def resolution(self):
         """Get the supply curve resolution."""
         return self.get('resolution', self._default_resolution)
 
+    @property
+    def grid_cell_size(self):
+        """Get the length (m) of a side of each grid cell in `excl_fpath`."""
+        return self.get('grid_cell_size', self._default_grid_cell_size)
+
+    @property
+    def max_flicker_exclusion_range(self):
+        """
+        Get the max distance (m) that flicker exclusions will extend in
+        any of the cardinal directions.
+        """
+        return self.get('max_flicker_exclusion_range',
+                        self._default_max_flicker_exclusion_range)
+
     @property
     def building_threshold(self):
         """
@@ -88,3 +116,46 @@ def out_layer(self):
         be saved
         """
         return self.get('out_layer', None)
+
+    @property
+    def replace(self):
+        """Get replace flag"""
+        return self.get('replace', False)
+
+    @property
+    def hsds(self):
+        """Get hsds flag"""
+        return self.get('hsds', self._default_hsds_flag)
+
+
+def validate_feature_input(features_path=None, building_layer=None):
+    """Validate the feature input.
+
+    Specifically, this function raises an error unless exactly one of
+    the following inputs are provided:
+        - features_path
+        - building_layer
+
+    Parameters
+    ----------
+    features_path : str | int
+        Path to input tif  containing buildings from which turbine
+        flicker exclusions will be computed. By default, `None`.
+    building_layer : float | int
+        Exclusion layer containing buildings from which turbine
+        flicker exclusions will be computed. By default, `None`.
+
+    Raises
+    ------
+    RuntimeError
+        If not enough info is provided (all inputs are `None`), or too
+        much info is given (all inputs are not `None`).
+    """
+    no_features_path = features_path is None
+    no_building_layer = building_layer is None
+
+    not_enough_info = no_features_path and no_building_layer
+    too_much_info = not no_features_path and not no_building_layer
+    if not_enough_info or too_much_info:
+        raise RuntimeError("Must provide either `features_path` or "
+                           "`building_layer` (but not both).")

reVX/least_cost_xmission/cost_creator.py

@@ -9,7 +9,7 @@
 from reV.handlers.exclusions import ExclusionLayers
 
 from reVX.handlers.geotiff import Geotiff
-from reVX.utilities.exclusions_converter import ExclusionsConverter
+from reVX.utilities import ExclusionsConverter
 from reVX.least_cost_xmission.config import XmissionConfig
 
 logger = logging.getLogger(__name__)

reVX/least_cost_xmission/least_cost_paths.py

@@ -19,7 +19,7 @@
 from rex.utilities.loggers import log_mem
 
 from reVX.least_cost_xmission.trans_cap_costs import TieLineCosts
-from reVX.utilities.exclusions_converter import ExclusionsConverter
+from reVX.utilities import ExclusionsConverter
 
 logger = logging.getLogger(__name__)
 

reVX/offshore/dist_to_ports.py

@@ -14,7 +14,7 @@
 from warnings import warn
 
 from reV.handlers.exclusions import ExclusionLayers
-from reVX.utilities.exclusions_converter import ExclusionsConverter
+from reVX.utilities import ExclusionsConverter
 from reVX.utilities.utilities import log_versions, coordinate_distance
 from rex.utilities.execution import SpawnProcessPool
 from rex.utilities.loggers import log_mem

reVX/offshore/dist_to_ports_converter.py

@@ -11,7 +11,7 @@
 
 from reVX.handlers.geotiff import Geotiff
 from reVX.handlers.outputs import Outputs
-from reVX.utilities.exclusions_converter import ExclusionsConverter
+from reVX.utilities import ExclusionsConverter
 
 logger = logging.getLogger(__name__)