pvlib · wholmgren · May 14, 2021 · Apr 15, 2021 · Apr 15, 2021 · Apr 15, 2021
diff --git a/docs/sphinx/source/api.rst b/docs/sphinx/source/api.rst
@@ -239,6 +239,7 @@ PV temperature models
   temperature.fuentes
   temperature.ross
   temperature.noct_sam
+   pvsystem.PVSystem.get_cell_temperature
   pvsystem.PVSystem.sapm_celltemp
   pvsystem.PVSystem.pvsyst_celltemp
   pvsystem.PVSystem.faiman_celltemp

diff --git a/docs/sphinx/source/whatsnew/v0.9.0.rst b/docs/sphinx/source/whatsnew/v0.9.0.rst
@@ -71,6 +71,16 @@ Deprecations
  * ``ModelChain.weather``
  * ``ModelChain.times``

+* The following ``PVSystem`` cell temperature methods have been deprecated
+  and consolidated into the new wrapper method
+  :py:meth:`~pvlib.pvsystem.PVSystem.get_cell_temperature` (:pull:`1211`):
+
+  * :py:meth:`~pvlib.pvsystem.PVSystem.sapm_celltemp`
+  * :py:meth:`~pvlib.pvsystem.PVSystem.pvsyst_celltemp`
+  * :py:meth:`~pvlib.pvsystem.PVSystem.faiman_celltemp`
+  * :py:meth:`~pvlib.pvsystem.PVSystem.fuentes_celltemp`
+  * :py:meth:`~pvlib.pvsystem.PVSystem.noct_sam_celltemp`
+
 * The ``eta_m`` parameter for :py:func:`~pvlib.temperature.pvsyst_cell` is
  replaced by parameter ``module_efficiency``. (:issue:`1188`, :pull:`1218`)


diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py
@@ -992,12 +992,10 @@ def _set_celltemp(self, model):

        Parameters
        ----------
-        model : function
-            A function that takes POA irradiance, air temperature, and
-            wind speed and returns cell temperature. `model` must accept
-            tuples or single values for each parameter where each element of
-            the tuple is the value for a different array in the system
-            (see :py:class:`pvlib.pvsystem.PVSystem` for more information).
+        model : str
+            A cell temperature model name to pass to
+            :py:meth:`pvlib.pvsystem.PVSystem.get_cell_temperature`.
+            Valid names are 'sapm', 'pvsyst', 'faiman', 'fuentes', 'noct_sam'

        Returns
        -------
@@ -1009,26 +1007,26 @@ def _set_celltemp(self, model):
        temp_air = _tuple_from_dfs(self.results.weather, 'temp_air')
        wind_speed = _tuple_from_dfs(self.results.weather, 'wind_speed')
        kwargs = {}
-        if model == self.system.noct_sam_celltemp:
+        if model == 'noct_sam':
            kwargs['effective_irradiance'] = self.results.effective_irradiance
-        self.results.cell_temperature = model(poa, temp_air, wind_speed,
-                                              **kwargs)
+        self.results.cell_temperature = self.system.get_cell_temperature(
+            poa, temp_air, wind_speed, model=model, **kwargs)
        return self

    def sapm_temp(self):
-        return self._set_celltemp(self.system.sapm_celltemp)
+        return self._set_celltemp('sapm')

    def pvsyst_temp(self):
-        return self._set_celltemp(self.system.pvsyst_celltemp)
+        return self._set_celltemp('pvsyst')

    def faiman_temp(self):
-        return self._set_celltemp(self.system.faiman_celltemp)
+        return self._set_celltemp('faiman')

    def fuentes_temp(self):
-        return self._set_celltemp(self.system.fuentes_celltemp)
+        return self._set_celltemp('fuentes')

    def noct_sam_temp(self):
-        return self._set_celltemp(self.system.noct_sam_celltemp)
+        return self._set_celltemp('noct_sam')

    @property
    def dc_ohmic_model(self):
-Original file line number
+Diff line change
@@ -992,12 +992,10 @@ def _set_celltemp(self, model):
             Parameters
             ----------
-            model : function
-                A function that takes POA irradiance, air temperature, and
-                wind speed and returns cell temperature. `model` must accept
-                tuples or single values for each parameter where each element of
-                the tuple is the value for a different array in the system
-                (see :py:class:`pvlib.pvsystem.PVSystem` for more information).
+            model : str
+                A cell temperature model name to pass to
+                :py:meth:`pvlib.pvsystem.PVSystem.get_cell_temperature`.
                   kandersolar marked this conversation as resolved.
              

          
            Show resolved
            Hide resolved
        

                
  
            
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.
+                Valid names are 'sapm', 'pvsyst', 'faiman', 'fuentes', 'noct_sam'
             Returns
             -------
@@ -1009,26 +1007,26 @@ def _set_celltemp(self, model):
             temp_air = _tuple_from_dfs(self.results.weather, 'temp_air')
             wind_speed = _tuple_from_dfs(self.results.weather, 'wind_speed')
             kwargs = {}
-            if model == self.system.noct_sam_celltemp:
+            if model == 'noct_sam':
             Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            cwhanse
  

      

      

      


        Apr 26, 2021


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      The docstring says that model is a function, it's changed to be a string here and elsewhere.
With this change, is ModelChain.temperature_model needed?
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
            kandersolar reacted with thumbs up emoji
      
        
            
    All reactions
  


          
              
                👍
                  1 reaction
              
          
        
      
    

    



    
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            cwhanse
  

      

      

      


        May 14, 2021


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      
With this change, is ModelChain.temperature_model needed?

I think this question remains, but it should be explored in a separate issue.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
                 kwargs['effective_irradiance'] = self.results.effective_irradiance
-            self.results.cell_temperature = model(poa, temp_air, wind_speed,
-                                                  **kwargs)
+            self.results.cell_temperature = self.system.get_cell_temperature(
+                poa, temp_air, wind_speed, model=model, **kwargs)
             return self
         def sapm_temp(self):
-            return self._set_celltemp(self.system.sapm_celltemp)
+            return self._set_celltemp('sapm')
         def pvsyst_temp(self):
-            return self._set_celltemp(self.system.pvsyst_celltemp)
+            return self._set_celltemp('pvsyst')
         def faiman_temp(self):
-            return self._set_celltemp(self.system.faiman_celltemp)
+            return self._set_celltemp('faiman')
         def fuentes_temp(self):
-            return self._set_celltemp(self.system.fuentes_celltemp)
+            return self._set_celltemp('fuentes')
         def noct_sam_temp(self):
-            return self._set_celltemp(self.system.noct_sam_celltemp)
+            return self._set_celltemp('noct_sam')
         @property
         def dc_ohmic_model(self):
-          Expand Down