Merge remote-tracking branch 'upstream/main' into update_reindl_docs

Author: RDaxini

.github/workflows/asv_check.yml

@@ -16,12 +16,12 @@ jobs:
         shell: bash -el {0}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Install Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
 

.github/workflows/flake8.yml

@@ -6,9 +6,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Python 3.11
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
       - name: Install Flake8 5.0.4 linter

.github/workflows/publish.yml

@@ -15,12 +15,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     # fetch all commits and tags so versioneer works
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: 3.9
 

.github/workflows/pytest-remote-data.yml

@@ -66,18 +66,18 @@ jobs:
     if: (github.event_name == 'pull_request_target' && contains(github.event.pull_request.labels.*.name, 'remote-data')) || (github.event_name == 'push')
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         if: github.event_name == 'pull_request_target'
         # pull_request_target runs in the context of the target branch (pvlib/main),
         # but what we need is the hypothetical merge commit from the PR:
         with:
           ref: "refs/pull/${{ github.event.number }}/merge"
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         if: github.event_name == 'push'
 
       - name: Set up conda environment
-        uses: conda-incubator/setup-miniconda@v2
+        uses: conda-incubator/setup-miniconda@v3
         with:
           activate-environment: test_env
           environment-file: ${{ env.REQUIREMENTS }}

.github/workflows/pytest.yml

@@ -31,7 +31,7 @@ jobs:
     steps:
       # We check out only a limited depth and then pull tags to save time
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 100
 
@@ -60,7 +60,7 @@ jobs:
 
       - name: Install bare Python ${{ matrix.python-version }}${{ matrix.suffix }}
         if: matrix.environment-type == 'bare'
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 

docs/sphinx/source/whatsnew.rst

@@ -6,6 +6,7 @@ What's New
 
 These are new features and improvements of note in each release.
 
+.. include:: whatsnew/v0.11.2.rst
 .. include:: whatsnew/v0.11.1.rst
 .. include:: whatsnew/v0.11.0.rst
 .. include:: whatsnew/v0.10.5.rst

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

@@ -1,42 +1,40 @@
 .. _whatsnew_01110:
 
 
-v0.11.1 (Anticipated Sep, 2024)
--------------------------------
-
-Deprecations
-~~~~~~~~~~~~
-
+v0.11.1 (September 26, 2024)
+----------------------------
 
 Enhancements
 ~~~~~~~~~~~~
 * Add new function to calculate the average photon energy,
-  :py:func:`pvlib.spectrum.average_photon_energy`.
+  :py:func:`~pvlib.spectrum.average_photon_energy`.
   (:issue:`2135`, :pull:`2140`)
 * Add new losses function that accounts for non-uniform irradiance on bifacial
-  modules, :py:func:`pvlib.bifacial.power_mismatch_deline`.
+  modules, :py:func:`~pvlib.bifacial.power_mismatch_deline`.
   (:issue:`2045`, :pull:`2046`)
 * Add new parameters for min/max absolute air mass to
-  :py:func:`pvlib.spectrum.spectral_factor_firstsolar`.
+  :py:func:`~pvlib.spectrum.spectral_factor_firstsolar`.
   (:issue:`2086`, :pull:`2100`)
 * Add ``roll_utc_offset`` and ``coerce_year`` arguments to
-  :py:func:`pvlib.iotools.get_pvgis_tmy` to allow user to specify time zone,
+  :py:func:`~pvlib.iotools.get_pvgis_tmy` to allow user to specify time zone,
   rotate indices of TMY to begin at midnight, and force indices to desired
   year. (:issue:`2139`, :pull:`2138`)
 * Restructured the pvlib/spectrum folder by breaking up the contents of
   pvlib/spectrum/mismatch.py into pvlib/spectrum/mismatch.py,
   pvlib/spectrum/irradiance.py, and
   pvlib/spectrum/response.py. (:issue:`2125`, :pull:`2136`, :pull:`2151`)
 * Added function for calculating wind speed at different heights,
-  :py:func:`pvlib.atmosphere.windspeed_powerlaw`.
+  :py:func:`~pvlib.atmosphere.windspeed_powerlaw`.
   (:issue:`2118`, :pull:`2124`)
+* ``delta_t`` can now be specified with an array in the SPA functions.
+  The numba implementation now also allows calculation of ``delta_t``
+  internally.  (:issue:`2189`, :pull:`2190`)
 * The multithreaded SPA functions no longer emit a warning when calculating
   solar positions for short time series. (:pull:`2170`)
-* Implemented closed-form solution for alpha in :py:func:`pvlib.clearsky.detect_clearsky`, 
-  obviating the call to scipy.optimize that was prone to runtime errors and minimizing
+* Implemented closed-form solution for alpha in :py:func:`~pvlib.clearsky.detect_clearsky`, 
+  obviating the call to scipy.optimize, which was prone to runtime errors, and minimizing
   computation. (:issue:`2171`, :issue:`2216`, :pull:`2217`).
 
-
 Bug fixes
 ~~~~~~~~~
 * To prevent simulation output from differing slightly based on the time zone
@@ -55,27 +53,30 @@ Bug fixes
 
 Testing
 ~~~~~~~
-
+* Updated the tests for :py:func:`~pvlib.iotools.get_pvgis_tmy`
+  and :py:func:`~pvlib.iotools.read_pvgis_tmy` as the default
+  API endpoint has changed from 5.1 to 5.2. (:pull:`2222`)
+* Removed unused ``times`` input from ``dni_et`` fixture. (:issue:`2105`, :pull:`2156`)
 
 Documentation
 ~~~~~~~~~~~~~
-* Added gallery example demonstrating the application of
-  several spectral mismatch factor models.
-  (:issue:`2107`, :pull:`2114`)
-* Added gallery example demonstrating the application of
-  :py:func:`~pvlib.spectrum.average_photon_energy`. (:issue:`2194`, :pull:`2206`)
-* Added gallery example on calculating cell temperature for
-  floating PV. (:pull:`2110`)
-* Added gallery example demonstrating how to use
-  different Perez coefficients in a ModelChain.
-  (:issue:`2127`, :pull:`2148`)
-* Fixed examples in :py:func:`pvlib.shading.shaded_fraction1d`. (:pull:`#2215`)
-
-* Removed unused "times" input from dni_et() function (:issue:`2105`)
-* Updated :py:func:`pvlib.irradiance.haydavies` to include equation variable
-  definitions and a new "notes" section (:issue:`2183`, :pull:`2191`)
+* Added new gallery example pages for:
+  
+  - Demonstrating the application of several spectral mismatch factor models.
+    (:issue:`2107`, :pull:`2114`)
+  - Demonstrating the application of :py:func:`~pvlib.spectrum.average_photon_energy`.
+    (:issue:`2194`, :pull:`2206`)
+  - Calculating cell temperature for floating PV. (:pull:`2110`)
+  - Demonstrating how to use different Perez coefficients in a ModelChain.
+    (:issue:`2127`, :pull:`2148`)
 
-* Split the contributing page into several pages (:issue:`2210`, :pull:`2219`)
+* Fixed examples in :py:func:`~pvlib.shading.shaded_fraction1d`. (:pull:`2215`)
+* Updated model description, added equation variable definitions, and created a 
+  new "notes" section in :py:func:`~pvlib.irradiance.haydavies` and
+  :py:func:`~pvlib.irradiance.klucher`. (:issue:`2183`, :pull:`2191`,
+  :pull:`2192`)
+* Document units with Wm⁻² instead of W/m^2 throughout ``pvlib.irradiance``. (:issue:`2205`, :pull:`2191`)
+* Split the contributing page into several pages. (:issue:`2210`, :pull:`2219`)
 
 Requirements
 ~~~~~~~~~~~~
@@ -89,15 +90,23 @@ Contributors
 * Chris Deline (:ghuser:`cdeline`)
 * Ioannis Sifnaios (:ghuser:`IoannisSifnaios`)
 * Leonardo Micheli (:ghuser:`lmicheli`)
-* Echedey Luis (:ghuser:`echedey-ls`)
 * Rajiv Daxini (:ghuser:`RDaxini`)
 * Mark A. Mikofski (:ghuser:`mikofski`)
 * Ben Pierce (:ghuser:`bgpierc`)
 * Jose Meza (:ghuser:`JoseMezaMendieta`)
+* Kevin Anderson (:ghuser:`kandersolar`)
 * Luiz Reis (:ghuser:`luizreiscver`)
 * Carlos Cárdenas-Bravo (:ghuser:`cardenca`)
 * Marcos R. Escudero (:ghuser:`marc-resc`)
 * Bernat Nicolau (:ghuser:`BernatNicolau`)
 * Eduardo Sarquis (:ghuser:`EduardoSarquis`)
 * Adam R. Jensen (:ghuser:`AdamRJensen`)
 * Andrew B Godbehere (:ghuser:`agodbehere`)
+* Cliff Hansen (:ghuser:`cwhanse`)
+* Anton Driesse (:ghuser:`adriesse`)
+* Miguel Angel Sevillano Bendezú (:ghuser:`msevillanob`)
+* Erfan (:ghuser:`Metal-Bat`)
+* Will Holmgren (:ghuser:`wholmgren`)
+* Kurt Rhee (:ghuser:`kurt-rhee`)
+* :ghuser:`PhilBrk8`
+* Mark Campanelli (:ghuser:`markcampanelli`)

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

@@ -0,0 +1,32 @@
+.. _whatsnew_01120:
+
+
+v0.11.2 (Anticipated December, 2024)
+------------------------------------
+
+Deprecations
+~~~~~~~~~~~~
+
+
+Enhancements
+~~~~~~~~~~~~
+
+
+Documentation
+~~~~~~~~~~~~~
+* Edited docstrings for :py:func:`~pvlib.pvsystem.dc_ohms_from_percent` and
+  :py:func:`~pvlib.pvsystem.dc_ohmic_losses` for clarity. (:issue:`1601`, :pull:`2229`)
+
+
+Testing
+~~~~~~~
+
+
+Requirements
+~~~~~~~~~~~~
+
+
+Contributors
+~~~~~~~~~~~~
+* Cliff Hansen (:ghuser:`cwhanse`)
+

pvlib/data/pvgis_tmy_meta.json

@@ -1,93 +1,32 @@
-{
-  "inputs": {
-    "location": {
-      "description": "Selected location",
-      "variables": {
-        "latitude": {
-          "description": "Latitude",
-          "units": "decimal degree"
-        },
-        "longitude": {
-          "description": "Longitude",
-          "units": "decimal degree"
-        },
-        "elevation": {
-          "description": "Elevation",
-          "units": "m"
-        }
-      }
-    },
-    "meteo_data": {
-      "description": "Sources of meteorological data",
-      "variables": {
-        "radiation_db": {
-          "description": "Solar radiation database"
-        },
-        "meteo_db": {
-          "description": "Database used for meteorological variables other than solar radiation"
-        },
-        "year_min": {
-          "description": "First year of the calculations"
-        },
-        "year_max": {
-          "description": "Last year of the calculations"
-        },
-        "use_horizon": {
-          "description": "Include horizon shadows"
-        },
-        "horizon_db": {
-          "description": "Source of horizon data"
-        }
-      }
-    }
-  },
-  "outputs": {
-    "months_selected": {
-      "type": "time series",
-      "timestamp": "monthly",
-      "description": "months selected for the TMY"
-    },
-    "tmy_hourly": {
-      "type": "time series",
-      "timestamp": "hourly",
-      "variables": {
-        "T2m": {
-          "description": "2-m air temperature",
-          "units": "degree Celsius"
-        },
-        "RH": {
-          "description": "relative humidity",
-          "units": "%"
-        },
-        "G(h)": {
-          "description": "Global irradiance on the horizontal plane",
-          "units": "W/m2"
-        },
-        "Gb(n)": {
-          "description": "Beam/direct irradiance on a plane always normal to sun rays",
-          "units": "W/m2"
-        },
-        "Gd(h)": {
-          "description": "Diffuse irradiance on the horizontal plane",
-          "units": "W/m2"
-        },
-        "IR(h)": {
-          "description": "Surface infrared (thermal) irradiance on a horizontal plane",
-          "units": "W/m2"
-        },
-        "WS10m": {
-          "description": "10-m total wind speed",
-          "units": "m/s"
-        },
-        "WD10m": {
-          "description": "10-m wind direction (0 = N, 90 = E)",
-          "units": "degree"
-        },
-        "SP": {
-          "description": "Surface (air) pressure",
-          "units": "Pa"
-        }
-      }
-    }
-  }
-}
+{"inputs": {"location": {"description": "Selected location",
+   "variables": {"latitude": {"description": "Latitude",
+     "units": "decimal degree"},
+    "longitude": {"description": "Longitude", "units": "decimal degree"},
+    "elevation": {"description": "Elevation", "units": "m"}}},
+  "meteo_data": {"description": "Sources of meteorological data",
+   "variables": {"radiation_db": {"description": "Solar radiation database"},
+    "meteo_db": {"description": "Database used for meteorological variables other than solar radiation"},
+    "year_min": {"description": "First year of the calculations"},
+    "year_max": {"description": "Last year of the calculations"},
+    "use_horizon": {"description": "Include horizon shadows"},
+    "horizon_db": {"description": "Source of horizon data"}}}},
+ "outputs": {"months_selected": {"type": "time series",
+   "timestamp": "monthly",
+   "description": "months selected for the TMY"},
+  "tmy_hourly": {"type": "time series",
+   "timestamp": "hourly",
+   "variables": {"T2m": {"description": "2-m air temperature",
+     "units": "degree Celsius"},
+    "RH": {"description": "relative humidity", "units": "%"},
+    "G(h)": {"description": "Global irradiance on the horizontal plane",
+     "units": "W/m2"},
+    "Gb(n)": {"description": "Beam/direct irradiance on a plane always normal to sun rays",
+     "units": "W/m2"},
+    "Gd(h)": {"description": "Diffuse irradiance on the horizontal plane",
+     "units": "W/m2"},
+    "IR(h)": {"description": "Surface infrared (thermal) irradiance on a horizontal plane",
+     "units": "W/m2"},
+    "WS10m": {"description": "10-m total wind speed", "units": "m/s"},
+    "WD10m": {"description": "10-m wind direction (0 = N, 90 = E)",
+     "units": "degree"},
+    "SP": {"description": "Surface (air) pressure", "units": "Pa"}}}}}