review comments

Author: cwhanse

docs/sphinx/source/whatsnew/v0.11.2.rst

@@ -47,9 +47,9 @@ Documentation
   page, using the sphinx glossary directive. (:issue:`1421`, :pull:`2234`)
 * Explained how to write docstrings for new functions in :ref:`example-docstring`
   (:discussion:`2081`, :pull:`2254`)
-* Clarify mounting cases for parameters for :py:func:`~pvlib.temperature.sapm_module`
+* Clarify mounting cases for parameters for :py:func:`~pvlib.temperature.sapm_module`,
   :py:func:`~pvlib.temperature.sapm_cell` and :py:func:`~pvlib.temperature.pvsyst_cell`.
-   (:issue:`1323`, :pull:`2293`)
+  (:issue:`1323`, :pull:`2293`)
 * Added the following variables to the :ref:`nomenclature` page:
 
   - `spectra` and `spectra_components` (:issue:`2150`, :pull:`2264`)

pvlib/pvsystem.py

@@ -169,8 +169,9 @@ class PVSystem:
 
     racking_model : string, optional
         Valid strings are ``'open_rack'``, ``'close_mount'``,
-        ``'freestanding'``, and ``'insulated_back'`. Used to identify a
-        parameter set for the SAPM cell temperature model.
+        ``'insulated_back'`, ``'freestanding'`` and ``'insulated'``.
+        Used to identify a parameter set for the SAPM or PVsyst cell
+        temperature model.
         See :py:func:`~pvlib.temperature.sapm_module` and
         :py:func:`~pvlib.temperature.pvsyst_cell` for definitions.
 
@@ -1396,8 +1397,9 @@ class FixedMount(AbstractMount):
 
     racking_model : str, optional
         Valid strings are ``'open_rack'``, ``'close_mount'``,
-        ``'freestanding'``, and ``'insulated_back'`. Used to identify a
-        parameter set for the SAPM cell temperature model.
+        ``'insulated_back'`, ``'freestanding'`` and ``'insulated'``.
+        Used to identify a parameter set for the SAPM or PVsyst cell
+        temperature model.
         See :py:func:`~pvlib.temperature.sapm_module`  and
         :py:func:`~pvlib.temperature.pvsyst_cell` for definitions.
 
@@ -1476,9 +1478,10 @@ class SingleAxisTrackerMount(AbstractMount):
 
     racking_model : str, optional
         Valid strings are ``'open_rack'``, ``'close_mount'``,
-        ``'freestanding'``, and ``'insulated_back'`. Used to identify a
-        parameter set for the SAPM cell temperature model.
-        ``'open_rack'`` should be used for systems with single-axis trackers.
+        ``'insulated_back'`, ``'freestanding'`` and ``'insulated'``.
+        Used to identify a parameter set for the SAPM or PVsyst cell
+        temperature model. ``'open_rack'`` should be used for systems with
+        single-axis trackers.
         See :py:func:`~pvlib.temperature.sapm_module` and
         :py:func:`~pvlib.temperature.pvsyst_cell` for definitions.
 

pvlib/temperature.py

@@ -118,7 +118,7 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT,
     +===============+================+=======+=========+=====================+
     | glass/glass   | open rack      | -3.47 | -0.0594 | 3                   |
     +---------------+----------------+-------+---------+---------------------+
-    | glass/glass   | close roof     | -2.98 | -0.0471 | 1                   |
+    | glass/glass   | close mount    | -2.98 | -0.0471 | 1                   |
     +---------------+----------------+-------+---------+---------------------+
     | glass/polymer | open rack      | -3.56 | -0.075  | 3                   |
     +---------------+----------------+-------+---------+---------------------+
@@ -131,7 +131,7 @@ def sapm_cell(poa_global, temp_air, wind_speed, a, b, deltaT,
     * "open rack" refers to mounting that allows relatively free air flow.
       This case is typical of ground-mounted systems on fixed racking or
       single axis trackers.
-    * "close roof" refers to limited or restricted air flow. This case is
+    * "close mount" refers to limited or restricted air flow. This case is
       typical of roof-mounted systems with some gap behind the module.
     * "insulated back" refers to systems with no air flow contacting the rear
       surface of the module. This case is typical of building-integrated PV
@@ -211,7 +211,7 @@ def sapm_module(poa_global, temp_air, wind_speed, a, b):
     +===============+================+=======+=========+=====================+
     | glass/glass   | open rack      | -3.47 | -0.0594 | 3                   |
     +---------------+----------------+-------+---------+---------------------+
-    | glass/glass   | close roof     | -2.98 | -0.0471 | 1                   |
+    | glass/glass   | close mount    | -2.98 | -0.0471 | 1                   |
     +---------------+----------------+-------+---------+---------------------+
     | glass/polymer | open rack      | -3.56 | -0.075  | 3                   |
     +---------------+----------------+-------+---------+---------------------+
@@ -224,7 +224,7 @@ def sapm_module(poa_global, temp_air, wind_speed, a, b):
     * "open rack" refers to mounting that allows relatively free air flow.
       This case is typical of ground-mounted systems on fixed racking or
       single axis trackers.
-    * "close roof" refers to limited or restricted air flow. This case is
+    * "close mount" refers to limited or restricted air flow. This case is
       typical of roof-mounted systems with some gap behind the module.
     * "insulated back" refers to systems with no air flow contacting the rear
       surface of the module. This case is typical of building-integrated PV
@@ -293,7 +293,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
     +===============+================+=======+=========+=====================+
     | glass/glass   | open rack      | -3.47 | -0.0594 | 3                   |
     +---------------+----------------+-------+---------+---------------------+
-    | glass/glass   | close roof     | -2.98 | -0.0471 | 1                   |
+    | glass/glass   | close mount    | -2.98 | -0.0471 | 1                   |
     +---------------+----------------+-------+---------+---------------------+
     | glass/polymer | open rack      | -3.56 | -0.075  | 3                   |
     +---------------+----------------+-------+---------+---------------------+
@@ -306,7 +306,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
     * "open rack" refers to mounting that allows relatively free air flow.
       This case is typical of ground-mounted systems on fixed racking or
       single axis trackers.
-    * "close roof" refers to limited or restricted air flow. This case is
+    * "close mount" refers to limited or restricted air flow. This case is
       typical of roof-mounted systems with some gap behind the module.
     * "insulated back" refers to systems with no air flow contacting the rear
       surface of the module. This case is typical of building-integrated PV
@@ -402,7 +402,7 @@ def pvsyst_cell(poa_global, temp_air, wind_speed=1.0, u_c=29.0, u_v=0.0,
     * "freestanding" refers to mounting that allows relatively free air
       circulation around the modules. This case is typical of ground-mounted
       systems on tilted, fixed racking or single axis trackers.
-    * "insluated" refers to mounting with air flow across only the front
+    * "insulated" refers to mounting with air flow across only the front
       surface. This case is typical of roof-mounted systems with no gap
       behind the module.