Merge branch 'main' into fix_some_examples_not_run_by_sphinx

Author: echedey-ls

.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/NX_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.
 #
@@ -142,17 +142,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)
@@ -174,20 +175,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,
 )
 
@@ -198,14 +199,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
 )
 
@@ -222,7 +223,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

@@ -22,6 +22,9 @@ Enhancements
 
 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
@@ -42,4 +45,6 @@ Maintenance
 
 Contributors
 ~~~~~~~~~~~~
-
+* Eesh Saxena (:ghuser:`eeshsaxena`)
+* Karl Hill (:ghuser:`karlhillx`)
+* Yonry Zhu (:ghuser:`yonryzhu`)

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/irradiance.py

@@ -3122,8 +3122,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