Merge remote-tracking branch 'upstream/main' into fix/line-endings-normalization

Author: Aditya-myst

.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 …amples/system-models/noplot_oedi_9068.pydocs/examples/system-models/oedi_9068.py renamed to docs/examples/system-models/noplot_oedi_9068.py docs/examples/system-models/oedi_9068.py renamed to docs/examples/system-models/noplot_oedi_9068.py

@@ -7,15 +7,21 @@
 """
 # %%
 # 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.
 #
 # The system has public monitoring data available at the Open Energy Data
 # Initiative (OEDI) under `System ID
-# 9068 <https://data.openei.org/s3_viewer?bucket=oedi-data-lake&prefix=pvdaq%2F2023-solar-data-prize%2F9068_OEDI%2F>`__.
+# 9068 <https://data.openei.org/s3_viewer?bucket=oedi-data-lake&prefix=pvdaq%2F2023-solar-data-prize%2F9068_OEDI%2F>`__.  # noqa: E501
 # For more information about the system, see its `OEDI
 # page <https://openei.org/wiki/PVDAQ/Sites/SR_CO>`__.
+#
+# .. warning::
+#    This example requires user-provided credentials to be run at step
+#    :ref:`Fetch weather data <fetch_weather_data>`. Therefore, it is not
+#    executed as part of documentation build process and it's more
+#    susceptible to API changes. Please, report any issues you may find.
 
 # sphinx_gallery_thumbnail_path = "_images/OEDI_9068_daily_timeseries.png"
 import pvlib
@@ -132,20 +138,22 @@
 # %%
 # Fetch weather data
 # ------------------
+# .. _fetch_weather_data:
 #
 # 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 +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,
 )
 
@@ -191,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
 )
 
@@ -215,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/conf.py

@@ -20,9 +20,9 @@
 # for generating GH links with linenumbers
 import inspect
 
-# import distutils before calling pd.show_versions()
-# https://github.com/pypa/setuptools/issues/3044
-import distutils  # noqa: F401
+# to escape special characters in sphinx-gallery OS-dependant regex
+import re
+
 import pandas as pd
 
 pd.show_versions()
@@ -384,12 +384,19 @@ def setup(app):
 # https://github.com/pvlib/pvlib-python/issues/837
 suppress_warnings = ['ref.footnote']
 
+os_re_sep = re.escape(os.path.sep)
 # settings for sphinx-gallery
 sphinx_gallery_conf = {
     'examples_dirs': ['../../examples'],  # location of gallery scripts
     'gallery_dirs': ['gallery'],  # location of generated output
-    # execute only files starting with plot_
-    'filename_pattern': 'plot_',
+
+    # do not execute gallery examples filenames that begin with noplot_
+    # first group + sep := match folders up to filename
+    # negative lookahead + match anything but sep := match filename (if valid)
+    # https://sphinx-gallery.github.io/stable/configuration.html#parsing-and-executing-examples-via-matching-patterns  # noqa: E501
+    # unix: filename_pattern = '^(.*)/(?!noplot_)([^/]*)$'
+    # win: filename_pattern = '^(.*)\\\\(?!noplot_)([^\\\\]*)$'
+    'filename_pattern': rf"^(.*){os_re_sep}(?!noplot_)([^{os_re_sep}]*)$",
 
     # directory where function/class granular galleries are stored
     'backreferences_dir': 'reference/generated/gallery_backreferences',

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

@@ -18,10 +18,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
@@ -38,8 +42,15 @@ Requirements
 
 Maintenance
 ~~~~~~~~~~~
+* Fix some gallery examples not being run. Only gallery examples whose filename begins with ``noplot_`` will be excluded. (:issue:`2790`, :pull:`2792`)
+* 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.