Merge branch 'main' into king-deprecation

Author: cbcrespo

.github/CONTRIBUTING.md

@@ -1,4 +1,4 @@
 Contributing
 ============
 
-We welcome your contributions! Please see the [contributing](http://pvlib-python.readthedocs.io/en/latest/contributing.html) page for information about how to contribute.
+We welcome your contributions! Please see the [contributing](https://pvlib-python.readthedocs.io/en/stable/contributing/index.html) page for information about how to contribute.

docs/examples/system-models/oedi_9068.py

@@ -7,7 +7,7 @@
 """
 # %%
 # This example model uses satellite-based solar resource data from the
-# NSRDB PSM3. This approach is useful for pre-construction energy modeling
+# NSRDB PSM4. This approach is useful for pre-construction energy modeling
 # and in retrospective analyses where the system’s own irradiance
 # measurements are not present or unreliable.
 #
@@ -135,17 +135,18 @@
 #
 # The system does have measured plane-of-array irradiance data, but the
 # measurements suffer from row-to-row shading and tracker stalls. In this
-# example, we will use weather data taken from the NSRDB PSM3 for the year
+# example, we will use weather data taken from the NSRDB PSM4 for the year
 # 2019.
 
 api_key = 'DEMO_KEY'
 email = 'your_email@domain.com'
 
 keys = ['ghi', 'dni', 'dhi', 'temp_air', 'wind_speed',
         'albedo', 'precipitable_water']
-psm3, psm3_metadata = pvlib.iotools.get_nsrdb_psm4_conus(latitude, longitude,
+psm4, psm4_metadata = pvlib.iotools.get_nsrdb_psm4_conus(latitude, longitude,
                                                          api_key, email,
-                                                         year=2019, interval=5,
+                                                         year=2019,
+                                                         time_step=5,
                                                          parameters=keys,
                                                          map_variables=True,
                                                          leap_day=True)
@@ -167,20 +168,20 @@
 # module fraction and returns the average irradiance over the total module
 # surface.
 
-solar_position = location.get_solarposition(psm3.index)
+solar_position = location.get_solarposition(psm4.index)
 tracker_angles = mount.get_orientation(
     solar_position['apparent_zenith'],
     solar_position['azimuth']
 )
-dni_extra = pvlib.irradiance.get_extra_radiation(psm3.index)
+dni_extra = pvlib.irradiance.get_extra_radiation(psm4.index)
 
 # note: this system is monofacial, so only calculate irradiance for the
 # front side:
 averaged_irradiance = pvlib.bifacial.infinite_sheds.get_irradiance_poa(
     tracker_angles['surface_tilt'], tracker_angles['surface_azimuth'],
     solar_position['apparent_zenith'], solar_position['azimuth'],
     gcr, axis_height, pitch,
-    psm3['ghi'], psm3['dhi'], psm3['dni'], psm3['albedo'],
+    psm4['ghi'], psm4['dhi'], psm4['dni'], psm4['albedo'],
     model='haydavies', dni_extra=dni_extra,
 )
 
@@ -191,14 +192,14 @@
 
 cell_temperature_steady_state = pvlib.temperature.faiman(
     poa_global=averaged_irradiance['poa_global'],
-    temp_air=psm3['temp_air'],
-    wind_speed=psm3['wind_speed'],
+    temp_air=psm4['temp_air'],
+    wind_speed=psm4['wind_speed'],
     **temperature_model_parameters,
 )
 
 cell_temperature = pvlib.temperature.prilliman(
     cell_temperature_steady_state,
-    psm3['wind_speed'],
+    psm4['wind_speed'],
     unit_mass=module_unit_mass
 )
 
@@ -215,7 +216,7 @@
     'poa_direct': averaged_irradiance['poa_direct'],
     'poa_diffuse': averaged_irradiance['poa_diffuse'],
     'cell_temperature': cell_temperature,
-    'precipitable_water': psm3['precipitable_water'],  # for the spectral model
+    'precipitable_water': psm4['precipitable_water'],  # for the spectral model
 })
 model.run_model_from_poa(weather_inputs)
 

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

@@ -21,10 +21,14 @@ Bug fixes
 
 Enhancements
 ~~~~~~~~~~~~
+* Ensure all timezones are available in all OSs. (:issue:`2795`, :pull:`2809`)
 
 
 Documentation
 ~~~~~~~~~~~~~
+* Fix broken link in GitHub Contributing tab. (:issue:`2628`, :pull:`2806`)
+* Fixed broken ``interval`` keyword argument in the ``oedi_9068`` gallery
+  example; the correct parameter name is ``time_step``. (:issue:`2791`)
 
 
 Testing
@@ -41,8 +45,14 @@ Requirements
 
 Maintenance
 ~~~~~~~~~~~
+* Removed unused internal function ``clearsky._is_leap_year`` (:issue:`2768`, :pull:`2813`)
+* Fix documentation builds on runner images lacking link-type timezones. (:issue:`2795`, :pull:`2809`)
 
 
 Contributors
 ~~~~~~~~~~~~
-
+* Eesh Saxena (:ghuser:`eeshsaxena`)
+* Karl Hill (:ghuser:`karlhillx`)
+* Mathias Aschwanden (:ghuser:`maschwanden`)
+* Yonry Zhu (:ghuser:`yonryzhu`)
+* Darshan Gowda (:ghuser:`dgowdaan-cmyk`)

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

@@ -0,0 +1,50 @@
+.. _whatsnew_0_16_0:
+
+
+v0.16.0
+Breaking Changes
+~~~~~~~~~~~~~~~~
+* Change output type of :py:func:`pvlib.irradiance.perez` and
+  :py:func:`pvlib.irradiance.perez_driesse` from ``OrderedDict`` to ``dict`` when
+  ``return_components=True`` to be consistent with other models.
+  (:pull:`2789`)
+* Remove empty ``poa_horizon`` key from the ``diffuse_components`` output of
+  :py:func:`pvlib.irradiance.haydavies`.
+  (:pull:`2788`)
+
+
+Deprecations
+~~~~~~~~~~~~
+
+
+Bug fixes
+~~~~~~~~~
+
+
+Enhancements
+~~~~~~~~~~~~
+
+
+Documentation
+~~~~~~~~~~~~~
+
+
+Testing
+~~~~~~~
+
+
+Benchmarking
+~~~~~~~~~~~~
+
+
+Requirements
+~~~~~~~~~~~~
+
+
+Maintenance
+~~~~~~~~~~~
+
+
+Contributors
+~~~~~~~~~~~~
+* Carolina Crespo (:ghuser:`cbcrespo`)

pvlib/bifacial/infinite_sheds.py

@@ -45,19 +45,6 @@ def _poa_sky_diffuse_pv(dhi, gcr, surface_tilt):
     Integrated view factors from the shaded and unshaded parts of
     the row slant height to the sky.
 
-    Parameters
-    ----------
-    f_x : numeric
-        Fraction of row slant height from the bottom that is shaded from
-        direct irradiance. [unitless]
-    surface_tilt : numeric
-        Surface tilt angle in degrees from horizontal, e.g., surface facing up
-        = 0, surface facing horizon = 90. [degree]
-    gcr : float
-        Ratio of row slant length to row spacing (pitch). [unitless]
-    npoints : int, default 100
-        Number of points for integration. [unitless]
-
     A detailed calculation would be
 
         dhi * (f_x * vf_shade_sky_integ + (1 - f_x) * vf_noshade_sky_integ)
@@ -73,9 +60,6 @@ def _poa_sky_diffuse_pv(dhi, gcr, surface_tilt):
 
     Parameters
     ----------
-    f_x : numeric
-        Fraction of row slant height from the bottom that is shaded from
-        direct irradiance. [unitless]
     dhi : numeric
         Diffuse horizontal irradiance (DHI). [W/m^2]
     gcr : float

pvlib/clearsky.py

@@ -220,22 +220,6 @@ def lookup_linke_turbidity(time, latitude, longitude, filepath=None,
     return linke_turbidity
 
 
-def _is_leap_year(year):
-    """Determine if a year is leap year.
-
-    Parameters
-    ----------
-    year : numeric
-
-    Returns
-    -------
-    isleap : array of bools
-    """
-    isleap = ((np.mod(year, 4) == 0) &
-              ((np.mod(year, 100) != 0) | (np.mod(year, 400) == 0)))
-    return isleap
-
-
 def _interpolate_turbidity(lts, time):
     """
     Interpolated monthly Linke turbidity onto daily values.

pvlib/irradiance.py

@@ -787,7 +787,7 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
 
     Returns
     --------
-    numeric, OrderedDict, or DataFrame
+    numeric, dict, or DataFrame
         Return type controlled by ``return_components`` argument.
         If `False`, ``sky_diffuse`` is returned.
         If `True`, ``diffuse_components`` is returned.
@@ -796,13 +796,11 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
         The sky diffuse component of the solar radiation on a tilted
         surface. [Wm⁻²]
 
-    diffuse_components : OrderedDict (array input) or DataFrame (Series input)
+    diffuse_components : dict (array input) or DataFrame (Series input)
         Keys/columns are:
             * poa_sky_diffuse: Total sky diffuse
             * poa_isotropic
             * poa_circumsolar
-            * poa_horizon (always zero, not accounted for by the
-              Hay-Davies model)
 
     Notes
     ------
@@ -860,14 +858,11 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
     sky_diffuse = poa_isotropic + poa_circumsolar
 
     if return_components:
-        diffuse_components = OrderedDict()
-        diffuse_components['poa_sky_diffuse'] = sky_diffuse
-
-        # Calculate the individual components
-        diffuse_components['poa_isotropic'] = poa_isotropic
-        diffuse_components['poa_circumsolar'] = poa_circumsolar
-        diffuse_components['poa_horizon'] = np.where(
-            np.isnan(diffuse_components['poa_isotropic']), np.nan, 0.)
+        diffuse_components = {
+            'poa_sky_diffuse': sky_diffuse,
+            'poa_isotropic': poa_isotropic,
+            'poa_circumsolar': poa_circumsolar
+        }
 
         if isinstance(sky_diffuse, pd.Series):
             diffuse_components = pd.DataFrame(diffuse_components)
@@ -1115,7 +1110,7 @@ def perez(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
 
     Returns
     --------
-    numeric, OrderedDict, or DataFrame
+    numeric, dict, or DataFrame
         Return type controlled by `return_components` argument.
         If ``return_components=False``, `sky_diffuse` is returned.
         If ``return_components=True``, `diffuse_components` is returned.
@@ -1124,7 +1119,7 @@ def perez(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
         The sky diffuse component of the solar radiation on a tilted
         surface.
 
-    diffuse_components : OrderedDict (array input) or DataFrame (Series input)
+    diffuse_components : dict (array input) or DataFrame (Series input)
         Keys/columns are:
             * poa_sky_diffuse: Total sky diffuse
             * poa_isotropic
@@ -1211,13 +1206,12 @@ def perez(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
         sky_diffuse = np.where(np.isnan(airmass), 0, sky_diffuse)
 
     if return_components:
-        diffuse_components = OrderedDict()
-        diffuse_components['poa_sky_diffuse'] = sky_diffuse
-
-        # Calculate the different components
-        diffuse_components['poa_isotropic'] = dhi * term1
-        diffuse_components['poa_circumsolar'] = dhi * term2
-        diffuse_components['poa_horizon'] = dhi * term3
+        diffuse_components = {
+            'poa_sky_diffuse': sky_diffuse,
+            'poa_isotropic': dhi * term1,
+            'poa_circumsolar': dhi * term2,
+            'poa_horizon': dhi * term3
+        }
 
         # Set values of components to 0 when sky_diffuse is 0
         mask = sky_diffuse == 0
@@ -1357,7 +1351,7 @@ def perez_driesse(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
 
     Returns
     --------
-    numeric, OrderedDict, or DataFrame
+    numeric, dict, or DataFrame
         Return type controlled by `return_components` argument.
         If ``return_components=False``, `sky_diffuse` is returned.
         If ``return_components=True``, `diffuse_components` is returned.
@@ -1366,7 +1360,7 @@ def perez_driesse(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
         The sky diffuse component of the solar radiation on a tilted
         surface.
 
-    diffuse_components : OrderedDict (array input) or DataFrame (Series input)
+    diffuse_components : dict (array input) or DataFrame (Series input)
         Keys/columns are:
             * poa_sky_diffuse: Total sky diffuse
             * poa_isotropic
@@ -1431,13 +1425,12 @@ def perez_driesse(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
     sky_diffuse = np.maximum(dhi * (term1 + term2 + term3), 0)
 
     if return_components:
-        diffuse_components = OrderedDict()
-        diffuse_components['poa_sky_diffuse'] = sky_diffuse
-
-        # Calculate the different components
-        diffuse_components['poa_isotropic'] = dhi * term1
-        diffuse_components['poa_circumsolar'] = dhi * term2
-        diffuse_components['poa_horizon'] = dhi * term3
+        diffuse_components = {
+            'poa_sky_diffuse': sky_diffuse,
+            'poa_isotropic': dhi * term1,
+            'poa_circumsolar': dhi * term2,
+            'poa_horizon': dhi * term3
+        }
 
         if isinstance(sky_diffuse, pd.Series):
             diffuse_components = pd.DataFrame(diffuse_components)
@@ -3128,8 +3121,8 @@ def _liujordan(zenith, transmittance, airmass, dni_extra=1367.0):
     transmittance: float
         Atmospheric transmittance between 0 and 1.
 
-    pressure: float, default 101325.0
-        Air pressure
+    airmass: numeric
+        Optical air mass. [unitless]
 
     dni_extra: float, default 1367.0
         Direct irradiance incident at the top of the atmosphere.

pvlib/pvsystem.py

@@ -395,7 +395,7 @@ def get_iam(self, aoi, iam_model='physical'):
         aoi : numeric or tuple of numeric
             The angle of incidence in degrees.
 
-        aoi_model : string, default 'physical'
+        iam_model : string, default 'physical'
             The IAM model to be used. Valid strings are 'physical', 'ashrae',
             'martin_ruiz', 'sapm' and 'interp'.
         Returns
@@ -1188,7 +1188,7 @@ def get_iam(self, aoi, iam_model='physical'):
         aoi : numeric
             The angle of incidence in degrees.
 
-        aoi_model : string, default 'physical'
+        iam_model : string, default 'physical'
             The IAM model to be used. Valid strings are 'physical', 'ashrae',
             'martin_ruiz', 'sapm' and 'interp'.
 

pvlib/solarposition.py

@@ -516,7 +516,7 @@ def sun_rise_set_transit_ephem(times, latitude, longitude,
 
     Parameters
     ----------
-    time : pandas.DatetimeIndex
+    times : pandas.DatetimeIndex
         Must be localized
     latitude : float
         Latitude in degrees, positive north of equator, negative to south

pyproject.toml

@@ -17,6 +17,7 @@ dependencies = [
     'requests',
     'scipy >= 1.7.2',
     'h5py',
+    'tzdata', # ensure all timezones are available in all installs for consistency GH#2795
 ]
 license = "BSD-3-Clause"
 classifiers = [