Skip to content

Commit

Permalink
cleaning up docstrings related to zones_dset and zone_mask
Browse files Browse the repository at this point in the history
  • Loading branch information
mjgleason committed Jan 21, 2025
1 parent 99368b2 commit b46d724
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 20 deletions.
23 changes: 13 additions & 10 deletions reV/supply_curve/points.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,8 @@ def __init__(
zone_mask : np.ndarray | None, optional
2D array defining zone within the supply curve to be evaluated,
where values of 0 or False will be excluded. The shape of this
array will be checked against the input resolution.
array will be checked against the input resolution. If not
specified, no zone mask will be applied.
"""

self._excl_dict = excl_dict
Expand Down Expand Up @@ -1032,8 +1033,9 @@ def __init__(
initialization.
zone_mask : np.ndarray | None, optional
2D array defining zone within the supply curve to be evaluated,
where 1 is included and 0 is excluded. The shape of this will be
checked against the input resolution.
where values of 0 or False will be excluded. The shape of this
array will be checked against the input resolution. If not
specified, no zone mask will be applied.
"""
super().__init__(
gid,
Expand Down Expand Up @@ -1550,9 +1552,10 @@ def __init__(
Flag to apply exclusions to the resource / generation gid's on
initialization.
zone_mask : np.ndarray | None, optional
2D array defining zone within the supply curve to be summarized,
where 1 is included and 0 is excluded. The shape of this will be
checked against the input resolution.
2D array defining zone within the supply curve to be evaluated,
where values of 0 or False will be excluded. The shape of this
array will be checked against the input resolution. If not
specified, no zone mask will be applied.
"""

self._res_class_dset = res_class_dset
Expand Down Expand Up @@ -2550,10 +2553,10 @@ def summarize(
fixed_charge_rate, capital_cost, fixed_operating_cost,
and variable_operating_cost.
zone_mask : np.ndarray | None, optional
2D array defining zone within the supply curve to be summarized,
where 1 is included and 0 is excluded. The shape of this will be
checked against the input resolution. If not specified, no zone
mask will be applied.
2D array defining zone within the supply curve to be evaluated,
where values of 0 or False will be excluded. The shape of this
array will be checked against the input resolution. If not
specified, no zone mask will be applied.
Returns
-------
Expand Down
26 changes: 16 additions & 10 deletions reV/supply_curve/sc_aggregation.py
Original file line number Diff line number Diff line change
Expand Up @@ -543,12 +543,15 @@ def __init__(self, excl_fpath, tm_dset, econ_fpath=None,
generation HDF5 output, or if `recalc_lcoe` is set to
``False``, the mean LCOE will be computed from the data
stored under the `lcoe_dset` instead. By default, ``True``.
zones_dset: str, optoinal
zones_dset: str, optional
Dataset name in `excl_fpath` containing the zones to be applied.
This data layer should consist of unique integer values for each
zone. Values of zero will be treated as no data /ignored. If
`zones_dset` is provided, supply curve aggregation will be applied
separately for each zone within each supply curve site.
If specified, supply curve aggregation will be performed separately
for each discrete zone within each supply curve site. This option
can be used for uses cases such as subdividing sites by parcel,
such that each parcel within each site is output to a separate
sc_gid. The input data layer should consist of unique integer
values for each zone. Values of zero will be treated as excluded
areas.
Examples
--------
Expand Down Expand Up @@ -1050,12 +1053,15 @@ def run_serial(
datasets to be aggregated in the h5_dsets input: system_capacity,
fixed_charge_rate, capital_cost, fixed_operating_cost,
and variable_operating_cost.
zones_dset: str, optoinal
zones_dset: str, optional
Dataset name in `excl_fpath` containing the zones to be applied.
This data layer should consist of unique integer values for each
zone. Values of zero will be treated as no data /ignored. If
`zones_dset` is provided, supply curve aggregation will be applied
separately for each zone within each supply curve site.
If specified, supply curve aggregation will be performed separately
for each discrete zone within each supply curve site. This option
can be used for uses cases such as subdividing sites by parcel,
such that each parcel within each site is output to a separate
sc_gid. The input data layer should consist of unique integer
values for each zone. Values of zero will be treated as excluded
areas.
Returns
-------
Expand Down

0 comments on commit b46d724

Please sign in to comment.