NREL-reV 0.14.2__py3-none-any.whl → 0.14.5__py3-none-any.whl

{nrel_rev-0.14.2.dist-info → nrel_rev-0.14.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: NREL-reV
-Version: 0.14.2
+Version: 0.14.5
 Summary: National Renewable Energy Laboratory's (NREL's) Renewable Energy Potential(V) Model: reV
 Author-email: Galen Maclaurin <galen.maclaurin@nrel.gov>
 Maintainer-email: Grant Buster <gbuster@nrel.gov>, Paul Pinchuk <ppinchuk@nrel.gov>
@@ -20,17 +20,17 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: NREL-gaps<0.9,>=0.8.0
-Requires-Dist: NREL-NRWAL<0.1,>=0.0.11
+Requires-Dist: NREL-gaps>=0.8.0
+Requires-Dist: NREL-NRWAL>=0.0.11
 Requires-Dist: NREL-PySAM~=7.0.0
-Requires-Dist: NREL-rex<0.4,>=0.3.5
+Requires-Dist: NREL-rex>=0.4.0
 Requires-Dist: numpy<3,>=2.0.2
 Requires-Dist: packaging<25,>=24.2
 Requires-Dist: plotly<7,>=6.0.1
 Requires-Dist: plotting<0.1,>=0.0.7
 Requires-Dist: shapely<3,>=2.0.7
 Provides-Extra: test
-Requires-Dist: pytest<9,>=8.3.3; extra == "test"
+Requires-Dist: pytest<9,>=8.4.0; extra == "test"
 Provides-Extra: dev
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"

{nrel_rev-0.14.2.dist-info → nrel_rev-0.14.5.dist-info}/RECORD

@@ -1,7 +1,7 @@
-nrel_rev-0.14.2.dist-info/licenses/LICENSE,sha256=hDwoTANtan2ZpufBlXm5C3W_PJ-mCqItvlcobgjxL7k,1526
+nrel_rev-0.14.5.dist-info/licenses/LICENSE,sha256=hDwoTANtan2ZpufBlXm5C3W_PJ-mCqItvlcobgjxL7k,1526
 reV/__init__.py,sha256=tXTpWu_qVo3uotfSw_TJ-gNbidGaIPPfUTwBlpCMJ-g,856
-reV/cli.py,sha256=u7G5M5moA7q8fCgC_1MB30Z7R14GNcngVf6eVNkfQU8,1682
-reV/version.py,sha256=iZ2NEm6j_ZMkwjscuehf0I9OUwsEHrSS3xbfjV9LCbM,51
+reV/cli.py,sha256=tkJzwkGNz0h7PfKpjUAv6aM-Jpn_z8jUbXyjb5GCFBM,1792
+reV/version.py,sha256=DNYUQmgQgGdiJDrMQAgH6IJ-51uB5WIunyqwp0YBFMM,51
 reV/SAM/SAM.py,sha256=3NK9rRaJzqH6wz7CU_5XguKCRhmoilOpDdFFsFgOaxQ,33163
 reV/SAM/__init__.py,sha256=LJqoncyKDY5ZP5WA4kboh561bce11F9Ge645Izah0EY,240
 reV/SAM/defaults.py,sha256=JQMJomX7wsbMzxKjx_IMnA_9QFsV2yWCyl_JToDVSJo,6703
@@ -16,19 +16,19 @@ reV/SAM/defaults/WY Southern-Flat Lands.srw,sha256=oSlFI7nnycW7SMnTXEXBXYkoh8rhV
 reV/SAM/defaults/geothermal.json,sha256=gnlxOBxxkbDDacIw6B9yP9iRkfmwj0WTWs8Zb71ytCo,7119
 reV/SAM/defaults/i_pvwattsv5.json,sha256=sF8rSe1bcqsKLXchvRxlp25dXOVe_q7rPJTf_vWR20Y,312
 reV/bespoke/__init__.py,sha256=vpXbyBUrUsTgK8UP_LafMjLiDg2CRG9WZLHPsOJoxek,109
-reV/bespoke/bespoke.py,sha256=ZMl4kz9oAaXpZaNa5EgiD43RvKiKl3xymRv-z4lDYmQ,113169
+reV/bespoke/bespoke.py,sha256=fZvNpNeKf8LYQbDDhX4I8iOgm_3MGdCf0aq-wzQcflo,116916
 reV/bespoke/cli_bespoke.py,sha256=b6Xu0GKpXqPX3qVJ6-z0FrO97uCsH_1dVOa4r6IvesQ,2911
 reV/bespoke/gradient_free.py,sha256=URWV1yiO2jyWk3_GOpfpLV_wlgJhXXGmTUwCB3WTV0Y,12015
 reV/bespoke/pack_turbs.py,sha256=Dcd9F8obF8LPztzeycB5kxa5hXKSCiz3jC1WeAFUx28,3508
-reV/bespoke/place_turbines.py,sha256=NfAs0OMaXPmwHnz9sTAtntWjvwGwSE8SCQ8fGlGzNoQ,25543
+reV/bespoke/place_turbines.py,sha256=pc5JofO9LAwwsQDGbxauGOoMeO6TXVr9uXABgVAADw0,27121
 reV/config/__init__.py,sha256=oqFNU4JESU_fPxFmPyQNFAXLDAdzmTlPuabXTe3Rf2Y,92
 reV/config/base_analysis_config.py,sha256=NvA3g5zQz8mIrV8ZSENLq0XBZGXa6RTGkwpZ76TVZj8,5615
 reV/config/base_config.py,sha256=a748VQ3CRs9RVi5sSEPcaWOyH6R3t5tssaFqZntHyaE,10075
 reV/config/cli_project_points.py,sha256=6edOlLNOG-ZEbcpNS2MPfu-DXjcOTEh_MEvKOvQSZj4,6010
 reV/config/curtailment.py,sha256=1bH7xzxOmD4PwLKcXFNotMAa9iCfGBUm2DKTOXViCJg,5548
 reV/config/execution.py,sha256=hyf8W7XYUXE6tXBXs-4En7h_aDTYu8FzbslgBsKLJkQ,5046
-reV/config/output_request.py,sha256=Sj3L5hcypLTCtLnKAqS7GSaI4_Hpb28QLuWT9IMCvrc,4520
-reV/config/project_points.py,sha256=CSq7lHgWfJ1pq1XlWJ5eykmGGhumkxVcg__Ln9RR4-Y,41886
+reV/config/output_request.py,sha256=cww5MxOUnXE_HwwLYitsFSwwUT8mWkctSElq9-zUl_8,4725
+reV/config/project_points.py,sha256=BdLwWrESsDZDQJ59rki-1Z0xXF4QUXZkbB8nsPrtOEA,42147
 reV/config/sam_config.py,sha256=xvvx2FTuliq0Sk-BjRE3I9zdDmIdwHVBnWtXCcsoc40,7998
 reV/econ/__init__.py,sha256=UId1LNaAP9lErCEXVce6JZf0qVRUvwNFOPrajdRevGo,130
 reV/econ/cli_econ.py,sha256=2KNy3JQD0EKjStaoD2r6nv3ELFw88h2E_up-UKj_sfE,4286
@@ -75,25 +75,25 @@ reV/rep_profiles/cli_rep_profiles.py,sha256=i3fRolT7HTzTQePXpNLDyxwgpRa7FEfHO1mO
 reV/rep_profiles/rep_profiles.py,sha256=dJ2jcklbelYYNS3IUXIYHg8E0poXLOWrwdqeBBnqYIE,48271
 reV/supply_curve/__init__.py,sha256=dbf0cO0qmt1VhV8dnDddztrcpnwua9T2HBhM6tLKaP8,274
 reV/supply_curve/aggregation.py,sha256=DvIUmj0PbZ8NxgOSmpXvzn9wJnOiQO2Xm2w_WCRVK-U,40908
-reV/supply_curve/cli_sc_aggregation.py,sha256=iDBHlUUPg-Ce4N4Rqb4scn8A_Ygq2q4i9v_ypbH-krs,3387
+reV/supply_curve/cli_sc_aggregation.py,sha256=fJwhOixN3VlzImHStWfcB8Bum_POY-RRgkhWi8Slgao,4633
 reV/supply_curve/cli_supply_curve.py,sha256=e-XrHQIe4OqWTL6u-TUAyHrw7Alk7vkXQ2HoLbE3zTM,2163
 reV/supply_curve/cli_tech_mapping.py,sha256=Dirn4JOmu_3BIP7WgcRLAepsreKqmDhChHLPEUqcDAo,1735
 reV/supply_curve/competitive_wind_farms.py,sha256=eOjM72-4oWtsqxB7Wh2gnB2zVAt4LY3iPE_DqWdXbQ4,15795
-reV/supply_curve/exclusions.py,sha256=4-ZxTO5Vlu03vie0V_74uvdajQfCuC8FE96Pg8I4U_c,42950
-reV/supply_curve/extent.py,sha256=a31po753hXSxQ8lfcCvpE8hoKc4bY7MmYq0NO0jtdqA,17414
-reV/supply_curve/points.py,sha256=p9Kqzas1jX8uCXcvYX7o6mdUVsgeHCC_F9pjBaEypPI,93548
-reV/supply_curve/sc_aggregation.py,sha256=l7uXs-grLb0enblPNsEDKccSP11WZ2Pah5baWtgtvzE,68067
+reV/supply_curve/exclusions.py,sha256=dzwgcXyDg5_MrcxKohW-j5YX7tWW6JlQimkUwLlhz2k,44056
+reV/supply_curve/extent.py,sha256=168Vcr2XQNkoLLn3xCLfvE3udi39wbtQ7GAbvw1yys0,17917
+reV/supply_curve/points.py,sha256=dl518Bv_i2jOM1N-BAVZcK3chmv23BphvHO47zcbTxU,94142
+reV/supply_curve/sc_aggregation.py,sha256=VaFKS_EIPqlxlpFlxUiZiI8q_mJWdamh9fSuF6LXm28,70843
 reV/supply_curve/supply_curve.py,sha256=9zhAA_9XSxE18j1Z9FuC71Wr3I0VuakfR5mt1_gHYuU,69931
-reV/supply_curve/tech_mapping.py,sha256=WP-o5Sk5q1Jz_F9Rpe77_fvTYGH8R4GnYDfRMSTuHB8,17804
-reV/utilities/__init__.py,sha256=HVb1P-ee-z2P6UTjyc0s0gYFK7XYM71BQLEMxj26apA,10834
+reV/supply_curve/tech_mapping.py,sha256=xP8j2KMY58kZ5MSH13nIs8IoDtFhNCzGY4hQeKxW33w,17878
+reV/utilities/__init__.py,sha256=b99Su_feREbuKkP71W_NrlO7GH9vQRsH7TrP7f4-Eg0,22703
 reV/utilities/_clean_readme.py,sha256=IFI9wGPX5nnLTNVLJzH8IOHq9unQlAlHRu4Namib0LA,709
-reV/utilities/cli_functions.py,sha256=1_T_sXz0Ct8lW-vOk3mMRcpD6NYsc9cGI7dEujIi9z4,3864
+reV/utilities/cli_functions.py,sha256=3q7d0MHNpb6vnzWSxQMPNXH176nGp_CHMgHCLknmv1k,5154
 reV/utilities/curtailment.py,sha256=As902-2aLGnCiVEutYfAFIOwuV--_rCQhxGNOY9RB-4,5241
 reV/utilities/exceptions.py,sha256=f7sRGsbFLpmL6Caq_H1cD4GfVhnLMyvYUsLPA1UVDDE,3974
 reV/utilities/pytest_utils.py,sha256=spCw9yQ8KEYOkQZpCi9IEmaWIvIqHqbUPDXXNQJJ68U,3241
 reV/utilities/slots.py,sha256=xsw-JuUVZ0YeoCNuwP_HxGNxFMA4xRs1tuImXHIJqaU,2618
-nrel_rev-0.14.2.dist-info/METADATA,sha256=lIgkZ3PQLu5YOtLYAP62nRtNVAhxkwRuHGqS_2mSwDY,10733
-nrel_rev-0.14.2.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-nrel_rev-0.14.2.dist-info/entry_points.txt,sha256=4IfJtZm2iMJwrbC8J0Or7VjZWnFpvCaHYVpvSWfIwDA,616
-nrel_rev-0.14.2.dist-info/top_level.txt,sha256=S6YF2ZYgXUB6n28SY0K2H8YB9tMJdXQ9CyQbo6VC89M,4
-nrel_rev-0.14.2.dist-info/RECORD,,
+nrel_rev-0.14.5.dist-info/METADATA,sha256=UCWoXqsoas-MeRXDg1ytuva-qI6B3XDpY1MhGb3ew_g,10718
+nrel_rev-0.14.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nrel_rev-0.14.5.dist-info/entry_points.txt,sha256=4IfJtZm2iMJwrbC8J0Or7VjZWnFpvCaHYVpvSWfIwDA,616
+nrel_rev-0.14.5.dist-info/top_level.txt,sha256=S6YF2ZYgXUB6n28SY0K2H8YB9tMJdXQ9CyQbo6VC89M,4
+nrel_rev-0.14.5.dist-info/RECORD,,

{nrel_rev-0.14.2.dist-info → nrel_rev-0.14.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

reV/bespoke/bespoke.py

@@ -258,8 +258,9 @@ class BespokeSinglePlant:
                  ws_bins=(0.0, 20.0, 5.0), wd_bins=(0.0, 360.0, 45.0),
                  excl_dict=None, inclusion_mask=None, data_layers=None,
                  resolution=64, excl_area=None, exclusion_shape=None,
-                 eos_mult_baseline_cap_mw=200, prior_meta=None, gid_map=None,
-                 bias_correct=None, pre_loaded_data=None, close=True):
+                 eos_mult_baseline_cap_mw=200, convex_hull_buffer=0,
+                 prior_meta=None, gid_map=None, bias_correct=None,
+                 pre_loaded_data=None, close=True):
         """
         Parameters
         ----------
@@ -309,7 +310,24 @@ class BespokeSinglePlant:
                   cost ($) as evaluated by
                   `balance_of_system_cost_function`
                 - ``self.wind_plant``: the SAM wind plant object,
-                  through which all SAM variables can be accessed
+                  through which all SAM variables can be accessed.
+
+                  .. IMPORTANT::
+                     When using the `self.wind_plant` variable,
+                     DO NOT include quotes around variable names (keys).
+
+                        - ❌ Wrong: ``self.wind_plant["annual_energy"]``
+                        - ✅ Correct: ``self.wind_plant[annual_energy]``
+
+                  .. IMPORTANT::
+                     It's possible for SAM wind plant variables to be
+                     ``None``, especially if something went wrong while
+                     optimizing the wind plant layout. In this case,
+                     your objective function may fail to evaluate and
+                     terminate the program entirely. To avoid this, add
+                     a default value for the variable in your objective
+                     function, like so:
+                     ``(self.wind_plant[annual_energy] or 0)``
 
         capital_cost_function : str
             The plant capital cost function as a string, must return the total
@@ -387,6 +405,10 @@ class BespokeSinglePlant:
             divided by the $-per-kW of a plant with this baseline
             capacity. By default, `200` (MW), which aligns the baseline
             with ATB assumptions. See here: https://tinyurl.com/y85hnu6h.
+        convex_hull_buffer : float, default=0
+            Buffer (in m) to apply to turbine location convex hull
+            before computing the convex hull area and capacity density.
+            By default, ``0``.
         prior_meta : pd.DataFrame | None
             Optional meta dataframe belonging to a prior run. This will only
             run the timeseries power generation step and assume that all of the
@@ -443,6 +465,11 @@ class BespokeSinglePlant:
                 eos_mult_baseline_cap_mw
             )
         )
+        logger.debug(
+            "Bespoke convex hull buffer: {:,} m".format(
+                convex_hull_buffer
+            )
+        )
 
         if isinstance(min_spacing, str) and min_spacing.endswith("x"):
             rotor_diameter = sam_sys_inputs["wind_turbine_rotor_diameter"]
@@ -475,6 +502,7 @@ class BespokeSinglePlant:
         self._ws_bins = ws_bins
         self._wd_bins = wd_bins
         self._baseline_cap_mw = eos_mult_baseline_cap_mw
+        self.convex_hull_buffer = convex_hull_buffer
 
         self._res_df = None
         self._prior_meta = prior_meta is not None
@@ -537,7 +565,8 @@ class BespokeSinglePlant:
         (ws_mean, *_mean) if requested.
         """
 
-        required = ("cf_mean", "annual_energy")
+        required = ("cf_mean", "annual_energy",
+                    "annual_wake_loss_internal_percent")
         for req in required:
             if req not in self._out_req:
                 self._out_req.append(req)
@@ -829,8 +858,12 @@ class BespokeSinglePlant:
         # `wind_plant_pd` PC may have PC losses applied, so keep the
         # original PC as to not double count losses here
         layout_config.pop("wind_turbine_powercurve_powerout", None)
-        config.update(layout_config)
 
+        # Don't bring over wind resource choice from `wind_plant_pd`
+        layout_config.pop("wind_resource_model_choice", None)
+        layout_config.pop("wind_resource_distribution", None)
+
+        config.update(layout_config)
         return config
 
     @property
@@ -1072,7 +1105,8 @@ class BespokeSinglePlant:
                 self.balance_of_system_cost_function,
                 self.include_mask,
                 self.pixel_side_length,
-                self.min_spacing)
+                self.min_spacing,
+                self.convex_hull_buffer)
 
         return self._plant_optm
 
@@ -1248,6 +1282,14 @@ class BespokeSinglePlant:
             for k, v in plant.outputs.items():
                 self._outputs[k + "-{}".format(year)] = v
 
+        self._compute_output_means()
+        self._add_extra_meta_columns()
+        logger.debug("Timeseries analysis complete!")
+
+        return self.outputs
+
+    def _compute_output_means(self):
+        """Compute time series means and store them in the outputs dict"""
         means = {}
         for k1, v1 in self._outputs.items():
             if isinstance(v1, Number) and parse_year(k1, option="boolean"):
@@ -1260,11 +1302,15 @@ class BespokeSinglePlant:
 
         self._outputs.update(means)
 
+    def _add_extra_meta_columns(self):
+        """Copy over some non-temporal datasets to meta"""
+
         self._meta[SupplyCurveField.MEAN_RES] = self.res_df["windspeed"].mean()
         self._meta[SupplyCurveField.MEAN_CF_DC] = np.nan
         self._meta[SupplyCurveField.MEAN_CF_AC] = np.nan
         self._meta[SupplyCurveField.MEAN_LCOE] = np.nan
         self._meta[SupplyCurveField.SC_POINT_ANNUAL_ENERGY_MWH] = np.nan
+        self._meta[SupplyCurveField.WAKE_LOSSES] = np.nan
         # copy dataset outputs to meta data for supply curve table summary
         if "cf_mean-means" in self.outputs:
             self._meta.loc[:, SupplyCurveField.MEAN_CF_AC] = self.outputs[
@@ -1279,10 +1325,10 @@ class BespokeSinglePlant:
             self._meta[SupplyCurveField.SC_POINT_ANNUAL_ENERGY_MWH] = (
                 self.outputs["annual_energy-means"] / 1000
             )
-
-        logger.debug("Timeseries analysis complete!")
-
-        return self.outputs
+        if "annual_wake_loss_internal_percent-means" in self.outputs:
+            self._meta[SupplyCurveField.WAKE_LOSSES] = (
+                self.outputs["annual_wake_loss_internal_percent-means"]
+            )
 
     def run_plant_optimization(self):
         """Run the wind plant layout optimization and export outputs
@@ -1314,10 +1360,14 @@ class BespokeSinglePlant:
         system_capacity_kw = self.plant_optimizer.capacity
         self._outputs["system_capacity"] = system_capacity_kw
 
-        txc = [int(np.round(c)) for c in self.plant_optimizer.turbine_x]
-        tyc = [int(np.round(c)) for c in self.plant_optimizer.turbine_y]
-        pxc = [int(np.round(c)) for c in self.plant_optimizer.x_locations]
-        pyc = [int(np.round(c)) for c in self.plant_optimizer.y_locations]
+        txc = [float(np.round(c, decimals=2))
+               for c in self.plant_optimizer.turbine_x]
+        tyc = [float(np.round(c, decimals=2))
+               for c in self.plant_optimizer.turbine_y]
+        pxc = [float(np.round(c, decimals=2))
+               for c in self.plant_optimizer.x_locations]
+        pyc = [float(np.round(c, decimals=2))
+               for c in self.plant_optimizer.y_locations]
 
         txc = json.dumps(txc)
         tyc = json.dumps(tyc)
@@ -1500,8 +1550,8 @@ class BespokeWindPlants(BaseAggregation):
                  excl_dict=None, area_filter_kernel='queen', min_area=None,
                  resolution=64, excl_area=None, data_layers=None,
                  pre_extract_inclusions=False, eos_mult_baseline_cap_mw=200,
-                 prior_run=None, gid_map=None, bias_correct=None,
-                 pre_load_data=False):
+                 convex_hull_buffer=0, prior_run=None, gid_map=None,
+                 bias_correct=None, pre_load_data=False):
         """reV bespoke analysis class.
 
         Much like generation, ``reV`` bespoke analysis runs SAM
@@ -1600,7 +1650,24 @@ class BespokeWindPlants(BaseAggregation):
                   cost ($) as evaluated by
                   `balance_of_system_cost_function`
                 - ``self.wind_plant``: the SAM wind plant object,
-                  through which all SAM variables can be accessed
+                  through which all SAM variables can be accessed.
+
+                  .. IMPORTANT::
+                     When using the `self.wind_plant` variable,
+                     DO NOT include quotes around variable names (keys).
+
+                        - ❌ Wrong: ``self.wind_plant["annual_energy"]``
+                        - ✅ Correct: ``self.wind_plant[annual_energy]``
+
+                  .. IMPORTANT::
+                     It's possible for SAM wind plant variables to be
+                     ``None``, especially if something went wrong while
+                     optimizing the wind plant layout. In this case,
+                     your objective function may fail to evaluate and
+                     terminate the program entirely. To avoid this, add
+                     a default value for the variable in your objective
+                     function, like so:
+                     ``(self.wind_plant[annual_energy] or 0)``
 
         capital_cost_function : str
             The plant capital cost function written out as a string.
@@ -1866,6 +1933,10 @@ class BespokeWindPlants(BaseAggregation):
             divided by the $-per-kW of a plant with this baseline
             capacity. By default, `200` (MW), which aligns the baseline
             with ATB assumptions. See here: https://tinyurl.com/y85hnu6h.
+        convex_hull_buffer : float, default=0
+            Buffer (in m) to apply to turbine location convex hull
+            before computing the convex hull area and capacity density.
+            By default, ``0``.
         prior_run : str, optional
             Optional filepath to a bespoke output HDF5 file belonging to
             a prior run. If specified, this module will only run the
@@ -1990,6 +2061,7 @@ class BespokeWindPlants(BaseAggregation):
         self._wd_bins = wd_bins
         self._data_layers = data_layers
         self._eos_mult_baseline_cap_mw = eos_mult_baseline_cap_mw
+        self._convex_hull_buffer = convex_hull_buffer
         self._prior_meta = self._parse_prior_run(prior_run)
         self._gid_map = BespokeSinglePlant._parse_gid_map(gid_map)
         self._bias_correct = Gen._parse_bc(bias_correct)
@@ -2466,8 +2538,9 @@ class BespokeWindPlants(BaseAggregation):
                    area_filter_kernel='queen', min_area=None,
                    resolution=64, excl_area=0.0081, data_layers=None,
                    gids=None, exclusion_shape=None, slice_lookup=None,
-                   eos_mult_baseline_cap_mw=200, prior_meta=None,
-                   gid_map=None, bias_correct=None, pre_loaded_data=None):
+                   eos_mult_baseline_cap_mw=200, convex_hull_buffer=0,
+                   prior_meta=None, gid_map=None, bias_correct=None,
+                   pre_loaded_data=None):
         """
         Standalone serial method to run bespoke optimization.
         See BespokeWindPlants docstring for parameter description.
@@ -2533,6 +2606,7 @@ class BespokeWindPlants(BaseAggregation):
                         data_layers=data_layers,
                         exclusion_shape=exclusion_shape,
                         eos_mult_baseline_cap_mw=eos_mult_baseline_cap_mw,
+                        convex_hull_buffer=convex_hull_buffer,
                         prior_meta=prior_meta,
                         gid_map=gid_map,
                         bias_correct=bias_correct,
@@ -2625,6 +2699,7 @@ class BespokeWindPlants(BaseAggregation):
                     exclusion_shape=self.shape,
                     slice_lookup=copy.deepcopy(self.slice_lookup),
                     eos_mult_baseline_cap_mw=self._eos_mult_baseline_cap_mw,
+                    convex_hull_buffer=self._convex_hull_buffer,
                     prior_meta=self._get_prior_meta(gid),
                     gid_map=self._gid_map,
                     bias_correct=self._get_bc_for_gid(gid),
@@ -2689,6 +2764,7 @@ class BespokeWindPlants(BaseAggregation):
                 afk = self._area_filter_kernel
                 i_bc = self._get_bc_for_gid(gid)
                 ebc = self._eos_mult_baseline_cap_mw
+                chb = self._convex_hull_buffer
 
                 si = self.run_serial(self._excl_fpath,
                                      self._res_fpath,
@@ -2713,6 +2789,7 @@ class BespokeWindPlants(BaseAggregation):
                                      data_layers=self._data_layers,
                                      slice_lookup=slice_lookup,
                                      eos_mult_baseline_cap_mw=ebc,
+                                     convex_hull_buffer=chb,
                                      prior_meta=prior_meta,
                                      gid_map=self._gid_map,
                                      bias_correct=i_bc,

reV/bespoke/place_turbines.py

@@ -3,6 +3,7 @@
 """
 place turbines for bespoke wind plants
 """
+import re
 from functools import wraps
 
 import numpy as np
@@ -53,7 +54,8 @@ class PlaceTurbines:
                  fixed_operating_cost_function,
                  variable_operating_cost_function,
                  balance_of_system_cost_function,
-                 include_mask, pixel_side_length, min_spacing):
+                 include_mask, pixel_side_length, min_spacing,
+                 convex_hull_buffer=0):
         """
         Parameters
         ----------
@@ -95,7 +97,24 @@ class PlaceTurbines:
                   cost ($) as evaluated by
                   `balance_of_system_cost_function`
                 - ``self.wind_plant``: the SAM wind plant object,
-                  through which all SAM variables can be accessed
+                  through which all SAM variables can be accessed.
+
+                  .. IMPORTANT::
+                     When using the `self.wind_plant` variable,
+                     DO NOT include quotes around variable names (keys).
+
+                        - ❌ Wrong: ``self.wind_plant["annual_energy"]``
+                        - ✅ Correct: ``self.wind_plant[annual_energy]``
+
+                  .. IMPORTANT::
+                     It's possible for SAM wind plant variables to be
+                     ``None``, especially if something went wrong while
+                     optimizing the wind plant layout. In this case,
+                     your objective function may fail to evaluate and
+                     terminate the program entirely. To avoid this, add
+                     a default value for the variable in your objective
+                     function, like so:
+                     ``(self.wind_plant[annual_energy] or 0)``
 
         capital_cost_function : str
             The plant capital cost function as a string, must return the
@@ -123,21 +142,28 @@ class PlaceTurbines:
             Side length (m) of a single pixel of the `include_mask`.
         min_spacing : float
             The minimum spacing between turbines (in meters).
+        convex_hull_buffer : float, default=0
+            Buffer (in m) to apply to turbine location convex hull
+            before computing the convex hull area and capacity density.
+            By default, ``0``.
         """
 
         # inputs
         self.wind_plant = wind_plant
 
-        self.capital_cost_function = capital_cost_function
-        self.fixed_operating_cost_function = fixed_operating_cost_function
-        self.variable_operating_cost_function = \
-            variable_operating_cost_function
-        self.balance_of_system_cost_function = balance_of_system_cost_function
+        self.capital_cost_function = _fix_wp_keys(capital_cost_function)
+        self.fixed_operating_cost_function = _fix_wp_keys(
+            fixed_operating_cost_function)
+        self.variable_operating_cost_function = _fix_wp_keys(
+            variable_operating_cost_function)
+        self.balance_of_system_cost_function = _fix_wp_keys(
+            balance_of_system_cost_function)
 
-        self.objective_function = objective_function
+        self.objective_function = _fix_wp_keys(objective_function)
         self.include_mask = include_mask
         self.pixel_side_length = pixel_side_length
         self.min_spacing = min_spacing
+        self.convex_hull_buffer = convex_hull_buffer
 
         # internal variables
         self.nrows, self.ncols = np.shape(include_mask)
@@ -152,7 +178,6 @@ class PlaceTurbines:
         self.safe_polygons = None
         self._optimized_nn_conn_dist_m = None
 
-        self.ILLEGAL = ('import ', 'os.', 'sys.', '.__', '__.', 'eval', 'exec')
         self._preflight(self.objective_function)
         self._preflight(self.capital_cost_function)
         self._preflight(self.fixed_operating_cost_function)
@@ -161,7 +186,10 @@ class PlaceTurbines:
 
     def _preflight(self, eqn):
         """Run preflight checks on the equation string."""
-        for substr in self.ILLEGAL:
+        _illegal_substr = ('import ', 'os.', 'sys.', '.__', '__.', 'eval',
+                           'exec')
+
+        for substr in _illegal_substr:
             if substr in str(eqn):
                 msg = ('Will not evaluate string which contains "{}": {}'
                        .format(substr, eqn))
@@ -455,7 +483,7 @@ class PlaceTurbines:
         turbines = MultiPoint([Point(x, y)
                                for x, y in zip(self.turbine_x,
                                                self.turbine_y)])
-        return turbines.convex_hull
+        return turbines.convex_hull.buffer(self.convex_hull_buffer)
 
     @property
     @none_until_optimized
@@ -650,3 +678,10 @@ def _compute_nn_conn_dist(x_coords, y_coords):
         left_to_connect.mask[next_connection] = 1
 
     return total_dist
+
+
+def _fix_wp_keys(eqn):
+    """Surround key of `self.wind_plant` in quotes"""
+    pattern = r'(self\.wind_plant\[\s*)([^\]]+?)(\s*\])'
+    replacement = r'\1"\2"\3'
+    return re.sub(pattern, replacement, str(eqn))

reV/cli.py

@@ -10,7 +10,8 @@ from reV.generation.cli_gen import gen_command
 from reV.econ.cli_econ import econ_command
 from reV.handlers.cli_collect import collect_command
 from reV.handlers.cli_multi_year import my_command
-from reV.supply_curve.cli_sc_aggregation import sc_agg_command
+from reV.supply_curve.cli_sc_aggregation import (sc_agg_command,
+                                                 sc_col_descriptions)
 from reV.supply_curve.cli_supply_curve import sc_command
 from reV.supply_curve.cli_tech_mapping import tm_command
 from reV.rep_profiles.cli_rep_profiles import rep_profiles_command
@@ -31,6 +32,7 @@ commands = [bespoke_command, gen_command, econ_command, collect_command,
 main = make_cli(commands, info={"name": "reV", "version": __version__})
 main.add_command(qa_qc_extra)
 main.add_command(project_points)
+main.add_command(sc_col_descriptions)
 
 # export GAPs commands to namespace for documentation
 batch = main.commands["batch"]

reV/config/output_request.py

@@ -107,6 +107,9 @@ class SAMOutputRequest(OutputRequest):
                    'wind_direction': 'winddirection',
                    'wind-direction': 'winddirection',
                    'wl': 'annual_wake_loss_internal_percent',
+                   'wakes': 'annual_wake_loss_internal_percent',
+                   'wake_loss': 'annual_wake_loss_internal_percent',
+                   'wake_losses': 'annual_wake_loss_internal_percent',
                    'wl_kwh': 'annual_wake_loss_internal_kWh',
                    'wl_pct': 'annual_wake_loss_total_percent',
                    'wl_ts': 'wake_loss_internal_percent',

reV/config/project_points.py

@@ -627,10 +627,14 @@ class ProjectPoints:
         # pylint: disable=no-member
         if SiteDataField.CONFIG not in df.columns:
             df[SiteDataField.CONFIG] = None
+        df[SiteDataField.CONFIG] = (df[SiteDataField.CONFIG]
+                                    .replace({np.nan: None}))
 
         # pylint: disable=no-member
         if SiteDataField.CURTAILMENT not in df.columns:
             df[SiteDataField.CURTAILMENT] = None
+        df[SiteDataField.CURTAILMENT] = (df[SiteDataField.CURTAILMENT]
+                                         .replace({np.nan: None}))
 
         gids = df[SiteDataField.GID].values
         if not np.array_equal(np.sort(gids), gids):

reV/supply_curve/cli_sc_aggregation.py

@@ -2,16 +2,21 @@
 """
 reV Supply Curve Aggregation CLI utility functions.
 """
-import os
 import logging
+from pathlib import Path
 
+import click
+import pandas as pd
+from rex import init_logger
 from rex.multi_file_resource import MultiFileResource
 from rex.utilities.utilities import check_res_file
 from gaps.cli import as_click_command, CLICommandFromClass
 
+from reV import __version__
 from reV.supply_curve.sc_aggregation import SupplyCurveAggregation
 from reV.utilities import ModuleName
-from reV.utilities.cli_functions import parse_from_pipeline
+from reV.utilities.cli_functions import (parse_from_pipeline,
+                                         compile_descriptions)
 from reV.utilities.exceptions import ConfigError
 
 
@@ -103,6 +108,38 @@ sc_agg_command = CLICommandFromClass(SupplyCurveAggregation, method="run",
 main = as_click_command(sc_agg_command)
 
 
+@click.command()
+@click.version_option(version=__version__)
+@click.option('--sc_fpath', '-sc', type=click.Path(), default=None,
+              help='Supply curve CSV file path used to subset the columns')
+@click.option('--out_fp', '-of', default=None, type=click.Path(),
+              help='Output CSV file for the column descriptions')
+@click.pass_context
+def sc_col_descriptions(ctx, sc_fpath, out_fp):
+    """Generate reV supply curve column descriptions"""
+    if ctx.obj.get('VERBOSE', False):
+        log_level = 'DEBUG'
+    else:
+        log_level = 'INFO'
+
+    init_logger('reV', log_level=log_level)
+
+    cols = []
+    if sc_fpath:
+        cols = pd.read_csv(sc_fpath, nrows=0).columns.tolist()
+
+    if not out_fp:
+        if sc_fpath:
+            sc_name = Path(sc_fpath).stem
+            out_fp = Path(sc_fpath).parent / f"{sc_name}_column_lookup.csv"
+        else:
+            out_fp = "rev_supply_curve_column_lookup.csv"
+
+    columns = compile_descriptions(cols)
+    columns.to_csv(out_fp, index=False)
+    logger.info("Column descriptions saved to %s", out_fp)
+
+
 if __name__ == '__main__':
     try:
         main(obj={})