pvlib 0.13.1__tar.gz → 0.14.0__tar.gz

{pvlib-0.13.1/pvlib.egg-info → pvlib-0.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pvlib
-Version: 0.13.1
+Version: 0.14.0
 Summary: A set of functions and classes for simulating the performance of photovoltaic energy systems.
 Home-page: https://github.com/pvlib/pvlib-python
 Author-email: pvlib python Developers <pvlib-admin@googlegroups.com>
@@ -29,7 +29,7 @@ Requires-Dist: cython; extra == "optional"
 Requires-Dist: ephem; extra == "optional"
 Requires-Dist: nrel-pysam; extra == "optional"
 Requires-Dist: numba>=0.17.0; extra == "optional"
-Requires-Dist: solarfactors; extra == "optional"
+Requires-Dist: solarfactors>=1.6.1; extra == "optional"
 Requires-Dist: statsmodels; extra == "optional"
 Provides-Extra: doc
 Requires-Dist: ipython; extra == "doc"
@@ -42,7 +42,7 @@ Requires-Dist: docutils==0.21; extra == "doc"
 Requires-Dist: pillow; extra == "doc"
 Requires-Dist: sphinx-toggleprompt==0.5.2; extra == "doc"
 Requires-Dist: sphinx-favicon; extra == "doc"
-Requires-Dist: solarfactors; extra == "doc"
+Requires-Dist: solarfactors>=1.6.1; extra == "doc"
 Requires-Dist: sphinx-hoverxref~=1.4.2; extra == "doc"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"

{pvlib-0.13.1 → pvlib-0.14.0}/docs/examples/irradiance-decomposition/plot_diffuse_fraction.py

@@ -44,7 +44,7 @@ solpos.index = greensboro.index  # reset index to end of the hour
 # %%
 # pvlib Decomposition Functions
 # -----------------------------
-# Methods for separating DHI into diffuse and direct components include:
+# Methods for separating GHI into diffuse and direct components include:
 # `DISC`_, `DIRINT`_, `Erbs`_, and `Boland`_.
 
 # %%
@@ -112,7 +112,7 @@ out_boland = out_boland.rename(
 # ----------------
 # In the plots below we compare the four decomposition models to the TMY3 file
 # for Greensboro, North Carolina. We also compare the clearness index, kt, with
-# GHI normalized by a reference irradiance, E0 = 1000 [W/m^2], to highlight
+# GHI normalized by a reference irradiance, E0 = 1000 [Wm⁻²], to highlight
 # spikes caused when cosine of zenith approaches zero, particularly at sunset.
 #
 # First we combine the dataframes for the decomposition models and the TMY3

{pvlib-0.13.1 → pvlib-0.14.0}/docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

@@ -14,7 +14,7 @@ solar-position data, and adjust DNI and POA-global irradiance.
 # After location information and a date range is established, solar position
 # data is calculated using :py:func:`pvlib.solarposition.get_solarposition`.
 # Horizon data is assigned, and interpolated to the solar azimuth time
-# series data. Finally, in times when solar elevation is greater than the
+# series data. Finally, in times when solar elevation is less than the
 # interpolated horizon elevation angle, DNI is set to 0.
 
 import numpy as np

{pvlib-0.13.1 → pvlib-0.14.0}/docs/examples/spectrum/average_photon_energy.py

@@ -11,8 +11,8 @@ Calculation of the Average Photon Energy from SPECTRL2 output.
 # This example demonstrates how to use the
 # :py:func:`~pvlib.spectrum.average_photon_energy` function to calculate the
 # Average Photon Energy (APE, :math:`\overline{E_\gamma}`) of spectral
-# irradiance distributions. This example uses spectral irradiance simulated
-# using :py:func:`~pvlib.spectrum.spectrl2`, but the same method is
+# irradiance distributions. This example uses clearsky spectral irradiance
+# simulated using :py:func:`~pvlib.spectrum.spectrl2`, but the same method is
 # applicable to spectral irradiance from any source.
 # More information on the SPECTRL2 model can be found in [1]_.
 # The APE parameter is a useful indicator of the overall shape of the solar
@@ -35,18 +35,19 @@ from scipy.integrate import trapezoid
 from pvlib import spectrum, solarposition, irradiance, atmosphere
 
 lat, lon = 39.742, -105.18  # NREL SRRL location
-tilt = 25
-azimuth = 180  # south-facing system
+surface_tilt = 25
+surface_azimuth = 180  # south-facing system
 pressure = 81190  # at 1828 metres AMSL, roughly
-water_vapor_content = 0.5  # cm
-tau500 = 0.1
+precipitable_water = 0.5  # cm
+aerosol_turbidity_500nm = 0.1
 ozone = 0.31  # atm-cm
 albedo = 0.2
 
 times = pd.date_range('2023-01-01 08:00', freq='h', periods=9,
                       tz='America/Denver')
 solpos = solarposition.get_solarposition(times, lat, lon)
-aoi = irradiance.aoi(tilt, azimuth, solpos.apparent_zenith, solpos.azimuth)
+aoi = irradiance.aoi(surface_tilt, surface_azimuth,
+                     solpos.apparent_zenith, solpos.azimuth)
 
 relative_airmass = atmosphere.get_relative_airmass(solpos.apparent_zenith,
                                                    model='kastenyoung1989')
@@ -64,13 +65,13 @@ relative_airmass = atmosphere.get_relative_airmass(solpos.apparent_zenith,
 spectra_components = spectrum.spectrl2(
     apparent_zenith=solpos.apparent_zenith,
     aoi=aoi,
-    surface_tilt=tilt,
+    surface_tilt=surface_tilt,
     ground_albedo=albedo,
     surface_pressure=pressure,
     relative_airmass=relative_airmass,
-    precipitable_water=water_vapor_content,
+    precipitable_water=precipitable_water,
     ozone=ozone,
-    aerosol_turbidity_500nm=tau500,
+    aerosol_turbidity_500nm=aerosol_turbidity_500nm,
 )
 
 # %%

{pvlib-0.13.1 → pvlib-0.14.0}/docs/examples/system-models/plot_oedi_9068.py

@@ -143,10 +143,12 @@ email = 'your_email@domain.com'
 
 keys = ['ghi', 'dni', 'dhi', 'temp_air', 'wind_speed',
         'albedo', 'precipitable_water']
-psm3, psm3_metadata = pvlib.iotools.get_psm3(latitude, longitude, api_key,
-                                             email, interval=5, names=2019,
-                                             map_variables=True, leap_day=True,
-                                             attributes=keys)
+psm3, psm3_metadata = pvlib.iotools.get_nsrdb_psm4_conus(latitude, longitude,
+                                                         api_key, email,
+                                                         year=2019, interval=5,
+                                                         parameters=keys,
+                                                         map_variables=True,
+                                                         leap_day=True)
 
 # %%
 # Pre-generate some model inputs

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst

@@ -12,9 +12,10 @@ Spectrum
    spectrum.calc_spectral_mismatch_field
    spectrum.spectral_factor_caballero
    spectrum.spectral_factor_firstsolar
-   spectrum.spectral_factor_sapm
-   spectrum.spectral_factor_pvspec
    spectrum.spectral_factor_jrc
+   spectrum.spectral_factor_polo
+   spectrum.spectral_factor_pvspec
+   spectrum.spectral_factor_sapm
    spectrum.sr_to_qe
    spectrum.qe_to_sr
    spectrum.average_photon_energy

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/iotools.rst

@@ -81,9 +81,6 @@ Satellite-derived irradiance and weather data for the Americas.
    iotools.get_nsrdb_psm4_conus
    iotools.get_nsrdb_psm4_full_disc
    iotools.read_nsrdb_psm4
-   iotools.get_psm3
-   iotools.read_psm3
-   iotools.parse_psm3
 
 
 Commercial datasets
@@ -236,6 +233,27 @@ lower quality.
 
    iotools.read_crn
 
+ECMWF ERA5
+^^^^^^^^^^
+
+A global reanalysis dataset providing weather and solar resource data.
+
+.. autosummary::
+   :toctree: generated/
+
+   iotools.get_era5
+
+MERRA-2
+^^^^^^^
+
+A global reanalysis dataset providing weather, aerosol, and solar irradiance
+data.
+
+.. autosummary::
+   :toctree: generated/
+
+   iotools.get_merra2
+
 
 Generic data file readers
 -------------------------

pvlib-0.14.0/docs/sphinx/source/reference/irradiance/angle-of-incidence.rst

@@ -0,0 +1,10 @@
+.. currentmodule:: pvlib
+
+Angle of incidence
+------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.aoi
+   irradiance.aoi_projection

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/irradiance/clearness-index.rst

@@ -1,7 +1,7 @@
 .. currentmodule:: pvlib
 
-Clearness index models
-----------------------
+Clearness and clearsky index
+----------------------------
 
 .. autosummary::
    :toctree: ../generated/

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/irradiance/decomposition.rst

@@ -2,8 +2,8 @@
 
 .. _dniestmodels:
 
-DNI estimation models
----------------------
+Decomposition models
+--------------------
 
 .. autosummary::
    :toctree: ../generated/
@@ -16,6 +16,4 @@ DNI estimation models
    irradiance.orgill_hollands
    irradiance.boland
    irradiance.campbell_norman
-   irradiance.gti_dirint
    irradiance.louche
-

pvlib-0.14.0/docs/sphinx/source/reference/irradiance/extraterrestrial-radiation.rst

@@ -0,0 +1,9 @@
+.. currentmodule:: pvlib
+
+Extraterrestrial radiation
+--------------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.get_extra_radiation

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/irradiance/index.rst

@@ -6,9 +6,10 @@ Irradiance
 .. toctree::
    :maxdepth: 2
 
-   class-methods
-   components
-   transposition
    decomposition
+   transposition
+   reverse-transposition
+   angle-of-incidence
    clearness-index
-   albedo
+   extraterrestrial-radiation
+   other

pvlib-0.13.1/docs/sphinx/source/reference/irradiance/albedo.rst → pvlib-0.14.0/docs/sphinx/source/reference/irradiance/other.rst

@@ -1,9 +1,12 @@
 .. currentmodule:: pvlib
 
-Albedo
-------
+Other
+-----
 
 .. autosummary::
    :toctree: ../generated/
 
+   irradiance.dni
+   irradiance.complete_irradiance
+   irradiance.diffuse_par_spitters
    albedo.inland_water_dvoracek

pvlib-0.14.0/docs/sphinx/source/reference/irradiance/reverse-transposition.rst

@@ -0,0 +1,10 @@
+.. currentmodule:: pvlib
+
+Reverse transposition models
+----------------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.ghi_from_poa_driesse_2023
+   irradiance.gti_dirint

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/irradiance/transposition.rst

@@ -8,6 +8,9 @@ Transposition models
 
    irradiance.get_total_irradiance
    irradiance.get_sky_diffuse
+   irradiance.get_ground_diffuse
+   irradiance.beam_component
+   irradiance.poa_components
    irradiance.isotropic
    irradiance.perez
    irradiance.perez_driesse
@@ -15,4 +18,3 @@ Transposition models
    irradiance.klucher
    irradiance.reindl
    irradiance.king
-   irradiance.ghi_from_poa_driesse_2023

pvlib-0.14.0/docs/sphinx/source/reference/location.rst

@@ -0,0 +1,31 @@
+.. currentmodule:: pvlib
+
+Location
+========
+
+Methods for information about locations.
+
+.. autosummary::
+   :toctree: generated/
+
+   location.lookup_altitude
+
+Classes
+-------
+.. autosummary::
+   :toctree: generated/
+   
+   location.Location
+
+A :py:class:`~pvlib.location.Location` object may be created from the
+metadata returned by these file types:
+
+.. autosummary::
+   :toctree: generated/
+
+   location.Location.from_tmy
+   location.Location.from_epw
+
+Methods for calculating time series of certain variables for a given
+location are available through this class.
+

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/pv_modeling/sdm.rst

@@ -17,6 +17,7 @@ Functions relevant for single diode models.
    pvsystem.v_from_i
    pvsystem.max_power_point
    ivtools.sdm.pvsyst_temperature_coeff
+   singlediode.batzelis
 
 Low-level functions for solving the single diode equation.
 
@@ -37,3 +38,4 @@ Functions for fitting diode models
     ivtools.sde.fit_sandia_simple
     ivtools.sdm.fit_cec_sam
     ivtools.sdm.fit_desoto
+    ivtools.sdm.fit_desoto_batzelis

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/reference/pv_modeling/system_models.rst

@@ -55,3 +55,11 @@ PVGIS model
    :toctree: ../generated/
 
     pvarray.huld
+
+Other
+^^^^^
+
+.. autosummary::
+   :toctree: ../generated/
+
+    pvarray.batzelis

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/user_guide/extras/faq.rst

@@ -52,15 +52,7 @@ Where can I get irradiance data for my simulation?
 
 pvlib has a module called iotools which has several functions for
 retrieving irradiance data as well as reading standard file formats
-such as EPW, TMY2, and TMY3. For free irradiance data, you may
-consider NREL's NSRDB which can be accessed using the
-:py:func:`pvlib.iotools.get_psm3` function and is available for
-North America. For Europe and Africa, you may consider looking into
-CAMS (:py:func:`pvlib.iotools.get_cams`).
-PVGIS (:py:func:`pvlib.iotools.get_pvgis_hourly`) is another option, which
-provides irradiance from several different databases with near global coverage.
-pvlib also has functions for accessing a plethora of ground-measured
-irradiance datasets, including the BSRN, SURFRAD, SRML, and NREL's MIDC.
+such as EPW, TMY2, and TMY3.  See :ref:`weatherdata`.
 
 
 Can I use PVsyst (PAN/OND) files with pvlib?

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/user_guide/getting_started/installation.rst

@@ -185,7 +185,7 @@ With your conda/virtual environment still active...
    Consider installing pvlib using ``pip install -e .[all]`` so that
    you can run the unit tests and build the documentation.
    Your clone directory is probably similar to
-   ``C:\Users\%USER%\Documents\GitHub\pvlib-python``(Windows) or
+   ``C:\Users\%USER%\Documents\GitHub\pvlib-python`` (Windows) or
    ``/Users/%USER%/Documents/pvlib-python`` (Mac).
 #. **Test** your installation by running ``python -c 'import pvlib'``.
    You're good to go if it returns without an exception.

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/user_guide/index.rst

@@ -26,6 +26,7 @@ This user guide is an overview and explains some of the key features of pvlib.
    modeling_topics/clearsky
    modeling_topics/weather_data
    modeling_topics/singlediode
+   modeling_topics/temperature
 
 .. toctree::
    :maxdepth: 2

pvlib-0.14.0/docs/sphinx/source/user_guide/modeling_topics/singlediode.rst

@@ -0,0 +1,217 @@
+.. _singlediode:
+
+Single diode models
+===================
+
+Single-diode models are a popular means of simulating the electrical output
+of a PV module under any given irradiance and temperature conditions.
+A single-diode model (SDM) pairs the single-diode equation (SDE) with a set of
+auxiliary equations that predict the SDE parameters at any given irradiance
+and temperature.  All SDMs use the SDE, but their auxiliary equations differ.
+For more background on SDMs, see the `PVPMC website
+<https://pvpmc.sandia.gov/modeling-guide/2-dc-module-iv/single-diode-equivalent-circuit-models/>`_.
+
+Three SDMs are currently available in pvlib: the CEC SDM, the PVsyst SDM,
+and the De Soto SDM.  pvlib splits these models into two steps.  The first
+is to compute the auxiliary equations using one of the following functions:
+
+* CEC SDM: :py:func:`~pvlib.pvsystem.calcparams_cec`
+* PVsyst SDM: :py:func:`~pvlib.pvsystem.calcparams_pvsyst`
+* De Soto SDM: :py:func:`~pvlib.pvsystem.calcparams_desoto`
+
+The second step is to use the output of these functions to compute points on
+the SDE's I-V curve. Three points on the SDE I-V curve are typically of special
+interest for PV modeling: the maximum power (MP), open circuit (OC), and
+short circuit (SC) points. The most convenient function for computing these
+points is :py:func:`pvlib.pvsystem.singlediode`. It provides several methods
+for solving the SDE:
+
++------------------+------------+-----------+-------------------------+
+| Method           | Type       | Speed     | Guaranteed convergence? |
++==================+============+===========+=========================+
+| ``newton``       | iterative  | fast      | no                      |
++------------------+------------+-----------+-------------------------+
+| ``brentq``       | iterative  | slow      | yes                     |
++------------------+------------+-----------+-------------------------+
+| ``chandrupatla`` | iterative  | fast      | yes                     |
++------------------+------------+-----------+-------------------------+
+| ``lambertw``     | explicit   | medium    | yes                     |
++------------------+------------+-----------+-------------------------+
+
+
+
+Computing full I-V curves
+-------------------------
+
+Full I-V curves can be computed using
+:py:func:`pvlib.pvsystem.i_from_v` and :py:func:`pvlib.pvsystem.v_from_i`, which
+calculate either current or voltage from the other, with the methods listed
+above.  It is often useful to
+first compute the open-circuit or short-circuit values using
+:py:func:`pvlib.pvsystem.singlediode` and then compute a range
+of voltages/currents from zero to those extreme points.  This range can then
+be used with the above functions to compute the I-V curve.
+
+
+IV curves in reverse bias
+-------------------------
+
+The standard SDE does not account for diode breakdown at reverse bias. The
+following functions can optionally include an extra term for modeling it:
+:py:func:`pvlib.pvsystem.max_power_point`,
+:py:func:`pvlib.singlediode.bishop88_i_from_v`,
+and :py:func:`pvlib.singlediode.bishop88_v_from_i`. 
+
+
+Recombination current for thin film cells
+-----------------------------------------
+
+The PVsyst SDM optionally modifies the SDE to better represent recombination
+current in CdTe and a-Si modules. The modified SDE requires two additional
+parameters. pvlib functions can compute the key points or full I-V curves using
+the modified SDE:
+:py:func:`pvlib.pvsystem.max_power_point`,
+:py:func:`pvlib.singlediode.bishop88_i_from_v`,
+and :py:func:`pvlib.singlediode.bishop88_v_from_i`.
+
+Model parameter values
+----------------------
+
+Despite some models having parameters with similar names, parameter values are
+specific to each model and thus must be produced with the intended model in mind.
+For some models, sets of parameter values can be read from external sources,
+for example:
+
+* CEC SDM parameter database can be read using :py:func:`~pvlib.pvsystem.retrieve_sam`
+* PAN files, which can be read using :py:func:`~pvlib.iotools.read_panond`
+
+pvlib also provides a set of functions that can estimate SDM parameter values
+from various datasources:
+
++---------------------------------------------------------------+---------+--------------------+
+| Function                                                      | SDM     | Inputs             |
++===============================================================+=========+====================+
+| :py:func:`~pvlib.ivtools.sdm.fit_cec_sam`                     | CEC     | datasheet          |
++---------------------------------------------------------------+---------+--------------------+
+| :py:func:`~pvlib.ivtools.sdm.fit_desoto`                      | De Soto | datasheet          |
++---------------------------------------------------------------+---------+--------------------+
+| :py:func:`~pvlib.ivtools.sdm.fit_desoto_sandia`               | De Soto | I-V curves         |
++---------------------------------------------------------------+---------+--------------------+
+| :py:func:`~pvlib.ivtools.sdm.fit_pvsyst_sandia`               | PVsyst  | I-V curves         |
++---------------------------------------------------------------+---------+--------------------+
+| :py:func:`~pvlib.ivtools.sdm.fit_pvsyst_iec61853_sandia_2025` | PVsyst  | IEC 61853-1 matrix |
++---------------------------------------------------------------+---------+--------------------+
+
+
+Single-diode equation
+---------------------
+
+This section reviews the solutions to the single diode equation used in
+pvlib-python to generate an IV curve of a PV module.
+
+pvlib-python supports two ways to solve the single diode equation:
+
+1. Lambert W-Function
+2. Bishop's Algorithm
+
+The :func:`pvlib.pvsystem.singlediode` function allows the user to choose the
+method using the ``method`` keyword.
+
+Lambert W-Function
+******************
+When ``method='lambertw'``, the Lambert W-function is used as previously shown
+by Jain, Kapoor [1, 2] and Hansen [3]. The following algorithm can be found on
+`Wikipedia: Theory of Solar Cells
+<https://en.wikipedia.org/wiki/Theory_of_solar_cells>`_, given the basic single
+diode model equation.
+
+.. math::
+
+   I = I_L - I_0 \left(\exp \left(\frac{V + I R_s}{n N_s V_{th}} \right) - 1 \right)
+       - \frac{V + I R_s}{R_{sh}}
+
+Lambert W-function is the inverse of the function
+:math:`f \left( w \right) = w \exp \left( w \right)` or
+:math:`w = f^{-1} \left( w \exp \left( w \right) \right)` also given as
+:math:`w = W \left( w \exp \left( w \right) \right)`. Defining the following
+parameter, :math:`z`, is necessary to transform the single diode equation into
+a form that can be expressed as a Lambert W-function.
+
+.. math::
+
+   z = \frac{R_s I_0}{n N_s V_{th} \left(1 + \frac{R_s}{R_{sh}} \right)} \exp \left(
+       \frac{R_s \left( I_L + I_0 \right) + V}{n N_s V_{th} \left(1 + \frac{R_s}{R_{sh}}\right)}
+       \right)
+
+Then the module current can be solved using the Lambert W-function,
+:math:`W \left(z \right)`.
+
+.. math::
+
+   I = \frac{I_L + I_0 - \frac{V}{R_{sh}}}{1 + \frac{R_s}{R_{sh}}}
+       - \frac{n N_s V_{th}}{R_s} W \left(z \right)
+
+
+Bishop's Algorithm
+******************
+The function :func:`pvlib.singlediode.bishop88` uses an explicit solution [4]
+that finds points on the IV curve by first solving for pairs :math:`(V_d, I)`
+where :math:`V_d` is the diode voltage :math:`V_d = V + I*Rs`. Then the voltage
+is backed out from :math:`V_d`. Points with specific voltage, such as open
+circuit, are located using the bisection search method, ``brentq``, bounded
+by a zero diode voltage and an estimate of open circuit voltage given by
+
+.. math::
+
+   V_{oc, est} = n N_s V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)
+
+We know that :math:`V_d = 0` corresponds to a voltage less than zero, and
+we can also show that when :math:`V_d = V_{oc, est}`, the resulting
+current is also negative, meaning that the corresponding voltage must be
+in the 4th quadrant and therefore greater than the open circuit voltage
+(see proof below). Therefore the entire forward-bias 1st quadrant IV-curve
+is bounded because :math:`V_{oc} < V_{oc, est}`, and so a bisection search
+between 0 and :math:`V_{oc, est}` will always find any desired condition in the
+1st quadrant including :math:`V_{oc}`.
+
+.. math::
+
+   I = I_L - I_0 \left(\exp \left(\frac{V_{oc, est}}{n N_s V_{th}} \right) - 1 \right)
+       - \frac{V_{oc, est}}{R_{sh}} \newline
+
+   I = I_L - I_0 \left(\exp \left(\frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{n N_s V_{th}} \right) - 1 \right)
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+
+   I = I_L - I_0 \left(\exp \left(\log \left(\frac{I_L}{I_0} + 1 \right) \right)  - 1 \right)
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+
+   I = I_L - I_0 \left(\frac{I_L}{I_0} + 1  - 1 \right)
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+
+   I = I_L - I_0 \left(\frac{I_L}{I_0} \right)
+       - \frac{n N_s V_{th} \log \left(\frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+
+   I = I_L - I_L - \frac{n N_s V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)}{R_{sh}} \newline
+
+   I = - \frac{n N_s V_{th} \log \left( \frac{I_L}{I_0} + 1 \right)}{R_{sh}}
+
+References
+----------
+[1] "Exact analytical solutions of the parameters of real solar cells using
+Lambert W-function," A. Jain, A. Kapoor, Solar Energy Materials and Solar Cells,
+81, (2004) pp 269-277.
+:doi:`10.1016/j.solmat.2003.11.018`
+
+[2] "A new method to determine the diode ideality factor of real solar cell
+using Lambert W-function," A. Jain, A. Kapoor, Solar Energy Materials and Solar
+Cells, 85, (2005) 391-396.
+:doi:`10.1016/j.solmat.2004.05.022`
+
+[3] "Parameter Estimation for Single Diode Models of Photovoltaic Modules,"
+Clifford W. Hansen, Sandia `Report SAND2015-2065
+<https://prod.sandia.gov/techlib-noauth/access-control.cgi/2015/152065.pdf>`_,
+2015 :doi:`10.13140/RG.2.1.4336.7842`
+
+[4] "Computer simulation of the effects of electrical mismatches in
+photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
+:doi:`10.1016/0379-6787(88)90059-2`

{pvlib-0.13.1 → pvlib-0.14.0}/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst

@@ -61,11 +61,21 @@ Reference [2]_.
 |                                                     +-----------------------------+         |    ✓    |  ✓   |      |      |            +   [4]_    |
 |                                                     | clearsky_index              |         |         |      |      |      |            |           |
 +-----------------------------------------------------+-----------------------------+---------+---------+------+------+------+------------+-----------+
+| :py:func:`Polo <spectral_factor_polo>`              | :term:`precipitable_water`, |         |         |      |      |      |            |           |
+|                                                     +-----------------------------+   ✓     |         |  ✓   |  ✓   |  ✓   |            +   [5]_    |
+|                                                     | :term:`airmass_absolute`,   |         |         |      |      |      |            |           |
+|                                                     +-----------------------------+         |         |      |      |      |            |           |
+|                                                     | aod500,                     |         |         |      |      |      |            |           |
+|                                                     +-----------------------------+         |         |      |      |      |            |           |
+|                                                     | :term:`aoi`,                |         |         |      |      |      |            |           |
+|                                                     +-----------------------------+         |         |      |      |      |            |           |
+|                                                     | :term:`pressure`            |         |         |      |      |      |            |           |
++-----------------------------------------------------+-----------------------------+---------+---------+------+------+------+------------+-----------+
 | :py:func:`PVSPEC <spectral_factor_pvspec>`          | :term:`airmass_absolute`,   |         |         |      |      |      |            |           |
-|                                                     +-----------------------------+   ✓     |    ✓    |  ✓   |  ✓   |  ✓   |            |   [5]_    |
+|                                                     +-----------------------------+   ✓     |    ✓    |  ✓   |  ✓   |  ✓   |            |   [6]_    |
 |                                                     | clearsky_index              |         |         |      |      |      |            |           |
 +-----------------------------------------------------+-----------------------------+---------+---------+------+------+------+------------+-----------+
-| :py:func:`SAPM <spectral_factor_sapm>`              | :term:`airmass_absolute`    |         |         |      |      |      |            |   [6]_    |
+| :py:func:`SAPM <spectral_factor_sapm>`              | :term:`airmass_absolute`    |         |         |      |      |      |            |   [7]_    |
 +-----------------------------------------------------+-----------------------------+---------+---------+------+------+------+------------+-----------+
 
 
@@ -88,16 +98,19 @@ References
        PVSPEC Model of Photovoltaic Spectral Mismatch Factor," in Proc. 2020
        IEEE 47th Photovoltaic Specialists Conference (PVSC), Calgary, AB,
        Canada, 2020, pp. 1–6. :doi:`10.1109/PVSC45281.2020.9300932`
-.. [5] D. L. King, W. E. Boyson, and J. A. Kratochvil, Photovoltaic Array
+.. [5] J. Polo and C. Sanz-Saiz, 'Development of spectral mismatch models
+       for BIPV applications in building façades', Renewable Energy, vol. 245,
+       p. 122820, Jun. 2025, :doi:`10.1016/j.renene.2025.122820`
+.. [6] D. L. King, W. E. Boyson, and J. A. Kratochvil, Photovoltaic Array
        Performance Model, Sandia National Laboratories, Albuquerque, NM, USA,
        Tech. Rep. SAND2004-3535, Aug. 2004. :doi:`10.2172/919131`
-.. [6] M. Lee and A. Panchula, "Spectral Correction for Photovoltaic Module
+.. [7] M. Lee and A. Panchula, "Spectral Correction for Photovoltaic Module
        Performance Based on Air Mass and Precipitable Water," 2016 IEEE 43rd
        Photovoltaic Specialists Conference (PVSC), Portland, OR, USA, 2016,
        pp. 3696-3699. :doi:`10.1109/PVSC.2016.7749836`
-.. [7] H. Thomas, S. Tony, and D. Ewan, “A Simple Model for Estimating the
-       Influence of Spectrum Variations on PV Performance,” pp. 3385–3389, Nov.
+.. [8] T. Huld, T. Sample, and E. Dunlop, "A Simple Model for Estimating the
+       Influence of Spectrum Variations on PV Performance," pp. 3385–3389, Nov.
        2009, :doi:`10.4229/24THEUPVSEC2009-4AV.3.27`
-.. [8] IEC 60904-7:2019, Photovoltaic devices — Part 7: Computation of the
+.. [9] IEC 60904-7:2019, Photovoltaic devices — Part 7: Computation of the
        spectral mismatch correction for measurements of photovoltaic devices, 
        International Electrotechnical Commission, Geneva, Switzerland, 2019.