pvlib 0.10.4__tar.gz → 0.10.5__tar.gz

{pvlib-0.10.4/pvlib.egg-info → pvlib-0.10.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pvlib
-Version: 0.10.4
+Version: 0.10.5
 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>
@@ -15,7 +15,7 @@ Classifier: Intended Audience :: Science/Research
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS.md
@@ -23,9 +23,8 @@ Requires-Dist: numpy>=1.17.3
 Requires-Dist: pandas>=1.3.0
 Requires-Dist: pytz
 Requires-Dist: requests
-Requires-Dist: scipy>=1.5.0
+Requires-Dist: scipy>=1.6.0
 Requires-Dist: h5py
-Requires-Dist: importlib-metadata; python_version < "3.8"
 Provides-Extra: optional
 Requires-Dist: cython; extra == "optional"
 Requires-Dist: ephem; extra == "optional"

{pvlib-0.10.4 → pvlib-0.10.5}/README.md

@@ -145,9 +145,8 @@ BSD 3-clause.
 History and acknowledgement
 ===========================
 
-pvlib python started out as a Python translation of the PVLIB MATLAB
-toolbox (developed by the [PVPMC](https://pvpmc.sandia.gov/) at
-Sandia National Laboratories) in 2013 and has grown substantially since then.
+pvlib python began in 2013 as a Python translation of the [PVLIB for Matlab](https://github.com/sandialabs/MATLAB_PV_LIB)
+toolbox developed by Sandia National Laboratories. pvlib python has grown substantially since then.
 Today it contains code contributions from over a hundred individuals worldwide
 and is maintained by a core group of PV modelers from a variety of institutions.
 

{pvlib-0.10.4 → pvlib-0.10.5}/docs/examples/shading/plot_partial_module_shading_simple.py

@@ -317,7 +317,7 @@ for diffuse_fraction in np.linspace(0, 1, 11):
 
 results = pd.DataFrame(data)
 results['pmp'] /= results['pmp'].max()  # normalize power to 0-1
-results_pivot = results.pivot('fd', 'fs', 'pmp')
+results_pivot = results.pivot(index='fd', columns='fs', values='pmp')
 plt.figure()
 plt.imshow(results_pivot, origin='lower', aspect='auto')
 plt.xlabel('shaded fraction')

{pvlib-0.10.4 → pvlib-0.10.5}/docs/examples/solar-position/plot_sunpath_diagrams.py

@@ -103,8 +103,7 @@ import matplotlib.pyplot as plt
 
 tz = 'Asia/Calcutta'
 lat, lon = 28.6, 77.2
-times = pd.date_range('2019-01-01 00:00:00', '2020-01-01', closed='left',
-                      freq='H', tz=tz)
+times = pd.date_range('2019-01-01 00:00:00', '2020-01-01', freq='H', tz=tz)
 
 solpos = solarposition.get_solarposition(times, lat, lon)
 # remove nighttime

{pvlib-0.10.4 → pvlib-0.10.5}/docs/examples/system-models/plot_oedi_9068.py

@@ -5,7 +5,6 @@
 A basic model of a 4.7 MW single-axis tracking CdTe system located in
 Colorado, United States.
 """
-
 # %%
 # This example model uses satellite-based solar resource data from the
 # NSRDB PSM3. This approach is useful for pre-construction energy modeling
@@ -18,6 +17,7 @@ Colorado, United States.
 # For more information about the system, see its `OEDI
 # page <https://openei.org/wiki/PVDAQ/Sites/SR_CO>`__.
 
+# sphinx_gallery_thumbnail_path = "_images/OEDI_9068_daily_timeseries.png"
 import pvlib
 import pandas as pd
 import matplotlib.pyplot as plt
@@ -46,7 +46,7 @@ strings_per_inverter = 1344
 
 # "unofficial" information
 
-# We know the system uses 117.5 W CdTe modules.  Based on the system vintage
+# We know the system uses 117.5 W CdTe modules. Based on the system vintage
 # (data begins in 2017), it seems likely that the array uses First Solar
 # Series 4 modules (FS-4117).
 cec_module_db = pvlib.pvsystem.retrieve_sam('cecmod')
@@ -66,7 +66,7 @@ module_unit_mass = 12 / 0.72  # kg/m^2, taken from datasheet values
 cec_inverter_db = pvlib.pvsystem.retrieve_sam('cecinverter')
 inverter_parameters = cec_inverter_db['TMEIC__PVL_L1833GRM']
 
-# We'll use the PVWatts v5 losses model.  Set shading to zero as it is
+# We'll use the PVWatts v5 losses model. Set shading to zero as it is
 # accounted for elsewhere in the model, and disable availability loss since
 # we want a "clean" simulation.
 # Leaving the other pvwatts loss types (mismatch, wiring, etc) unspecified
@@ -74,7 +74,7 @@ inverter_parameters = cec_inverter_db['TMEIC__PVL_L1833GRM']
 losses_parameters = dict(shading=0, availability=0)
 
 # Google Street View images show that each row is four modules high, in
-# landscape orientation.  Assuming the modules are First Solar Series 4,
+# landscape orientation. Assuming the modules are First Solar Series 4,
 # each of them is 600 mm wide.
 # Assume ~1 centimeter gap between modules (three gaps total).
 # And from Google Earth, the array's pitch is estimated to be about 7.0 meters.
@@ -231,7 +231,7 @@ df_inverter_measured = df_inverter_measured.tz_localize('US/Mountain',
                                                         ambiguous='NaT',
                                                         nonexistent='NaT')
 # convert to standard time to match the NSRDB-based simulation
-df_inverter_measred = df_inverter_measured.tz_convert('Etc/GMT+7')
+df_inverter_measured = df_inverter_measured.tz_convert('Etc/GMT+7')
 
 # %%
 

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/conf.py

@@ -364,8 +364,11 @@ sphinx_gallery_conf = {
     'backreferences_dir': 'reference/generated/gallery_backreferences',
 
     # Modules for which function/class level galleries are created. In
-    # this case only pvlib, could include others though.  must be tuple of str
+    # this case only pvlib, could include others though. Must be tuple of str
     'doc_module': ('pvlib',),
+
+    # https://sphinx-gallery.github.io/dev/configuration.html#removing-config-comments  # noqa: E501
+    'remove_config_comments': True,
 }
 # supress warnings in gallery output
 # https://sphinx-gallery.github.io/stable/configuration.html

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/contributing.rst

@@ -29,12 +29,8 @@ pvlib-python, git, or Python:
   `easy <https://github.com/pvlib/pvlib-python/labels/easy>`_,
   or `help wanted <https://github.com/pvlib/pvlib-python/labels/help%20wanted>`_.
 * Improve the documentation and the unit tests.
-* Improve the IPython/Jupyter Notebook tutorials or write new ones that
+* Improve the Example Gallery or add new examples that
   demonstrate how to use pvlib-python in your area of expertise.
-* If you have MATLAB experience, you can help us keep pvlib-python
-  up to date with PVLIB_MATLAB or help us develop common unit tests.
-  For more, see `Issue #2 <https://github.com/pvlib/pvlib-python/issues/2>`_
-  and `Issue #3 <https://github.com/pvlib/pvlib-python/issues/3>`_.
 * Tell your friends and colleagues about pvlib-python.
 * Add your project to our
   `Projects and publications that use pvlib-python wiki

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/index.rst

@@ -10,14 +10,13 @@ energy systems and accomplishing related tasks.
 The core mission of pvlib python is to provide open,
 reliable, interoperable, and benchmark implementations of PV system models.
 
-The source code for pvlib python is hosted on `github
+The source code for pvlib python is hosted on `GitHub
 <https://github.com/pvlib/pvlib-python>`_.
 Please see the :ref:`installation` page for installation help.
 
 For examples of how to use pvlib python, please see
-:ref:`package_overview` and our `Jupyter Notebook tutorials
-<http://nbviewer.org/github/pvlib/pvlib-python/tree/main/docs/
-tutorials/>`_. The documentation assumes general familiarity with
+:ref:`package_overview` and the :ref:`example_gallery`.
+The documentation assumes general familiarity with
 Python, NumPy, and Pandas. Google searches will yield many
 excellent tutorials for these packages.
 
@@ -34,11 +33,10 @@ ensure consistency throughout the library.
 History and acknowledgement
 ===========================
 
-pvlib python started out as a Python translation of the PVLIB MATLAB
-toolbox (developed by the `PVPMC <https://pvpmc.sandia.gov/>`_ at
-Sandia National Laboratories) in 2013 and has grown substantially since then.
+pvlib python began in 2013 as a Python translation of the `PVLIB for Matlab <https://github.com/sandialabs/MATLAB_PV_LIB>`_
+toolbox developed by Sandia National Laboratories. pvlib python has grown substantially since then.
 Today it contains code contributions from over a hundred individuals worldwide
-and is maintained by a core group of PV modelers from a variety institutions.
+and is maintained by a core group of PV modelers from a variety of institutions.
 
 pvlib has been supported directly and indirectly by DOE, NumFOCUS, and
 Google Summer of Code funding, university research projects,
@@ -57,7 +55,7 @@ use pvlib python in a published work, please cite:
   Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A.
   "pvlib python: 2023 project update."
   Journal of Open Source Software, 8(92), 5994, (2023).
-  https://doi.org/10.21105/joss.05994
+  :doi:`10.21105/joss.05994`.
 
 
 **Recommended citation for pvlib iotools**
@@ -65,14 +63,14 @@ use pvlib python in a published work, please cite:
   Jensen, A., Anderson, K., Holmgren, W., Mikofski, M., Hansen, C., Boeman, L., Loonen, R.
   "pvlib iotools — Open-source Python functions for seamless access to solar irradiance data."
   Solar Energy, 266, 112092, (2023).
-  https://doi.org/10.1016/j.solener.2023.112092
+  :doi:`10.1016/j.solener.2023.112092`.
 
 **Historical citation for pvlib python**
 
   Holmgren, W., Hansen, C., and Mikofski, M.
   "pvlib python: a python package for modeling solar energy systems."
   Journal of Open Source Software, 3(29), 884, (2018).
-  https://doi.org/10.21105/joss.00884
+  :doi:`10.21105/joss.00884`.
 
 **Version specific citation**
 Please also cite the DOI corresponding to the specific version of
@@ -82,26 +80,30 @@ pvlib python that you used. pvlib python DOIs are listed at
 
 Additional pvlib python publications include:
 
-* J. S. Stein, “The photovoltaic performance modeling
-  collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012.
+* J. S. Stein, "The Photovoltaic Performance Modeling Collaborative (PVPMC),"
+  2012 38th IEEE Photovoltaic Specialists Conference (PVSC),
+  Austin, TX, USA, 2012, pp. 003048-003052, :doi:`10.1109/PVSC.2012.6318225`.
 * R. W. Andrews, J. S. Stein, C. Hansen and D. Riley, "Introduction to the open
   source PV LIB for python Photovoltaic system modelling package," 
-  2014 IEEE 40th Photovoltaic Specialist Conference (PVSC), Denver, CO, USA, 
-  2014, pp. 0170-0174, https://doi.org/10.1109/PVSC.2014.6925501
+  2014 IEEE 40th Photovoltaic Specialist Conference (PVSC),
+  Denver, CO, USA, 2014, pp. 0170-0174, :doi:`10.1109/PVSC.2014.6925501`.
   (`paper
   <https://www.osti.gov/servlets/purl/1241774>`__)
-* W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein,
-  “PVLIB Python 2015,” in 42nd Photovoltaic Specialists Conference, 2015.
+* W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein, "PVLIB Python 2015,"
+  2015 IEEE 42nd Photovoltaic Specialist Conference (PVSC),
+  New Orleans, LA, USA, 2015, pp. 1-5, :doi:`10.1109/PVSC.2015.7356005`.
   (`paper
   <https://github.com/pvlib/pvsc2015/blob/main/pvlib_pvsc_42.pdf>`__ and
   the `notebook to reproduce the figures
   <http://nbviewer.org/github/pvlib/pvsc2015/blob/main/paper.ipynb>`_)
 * J.S. Stein, W.F. Holmgren, J. Forbess, and C.W. Hansen,
-  "PVLIB: Open Source Photovoltaic Performance Modeling Functions
-  for Matlab and Python," in 43rd Photovoltaic Specialists Conference, 2016.
+  "PVLIB: Open Source Photovoltaic Performance Modeling Functions for Matlab and Python,"
+  2016 IEEE 43rd Photovoltaic Specialists Conference (PVSC),
+  Portland, OR, USA, 2016, pp. 3425-3430, :doi:`10.1109/PVSC.2016.7750303`.
 * W.F. Holmgren and D.G. Groenendyk,
   "An Open Source Solar Power Forecasting Tool Using PVLIB-Python,"
-  in 43rd Photovoltaic Specialists Conference, 2016.
+  2016 IEEE 43rd Photovoltaic Specialists Conference (PVSC),
+  Portland, OR, USA, 2016, pp. 0972-0975, :doi:`10.1109/PVSC.2016.7749755`.
 
 
 Logo

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/reference/pv_modeling/system_models.rst

@@ -13,10 +13,11 @@ Sandia array performance model (SAPM)
    pvsystem.sapm
    pvsystem.sapm_effective_irradiance
    pvsystem.sapm_spectral_loss
+   spectrum.spectral_factor_sapm
    inverter.sandia
    temperature.sapm_cell
 
-Pvsyst model
+PVsyst model
 ^^^^^^^^^^^^
 
 .. autosummary::

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/user_guide/index.rst

@@ -15,7 +15,6 @@ User Guide
    clearsky
    bifacial
    weather_data
-   comparison_pvlib_matlab
    variables_style_rules
    singlediode
    faq

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/user_guide/installation.rst

@@ -83,15 +83,10 @@ for a password then you're probably trying to install pvlib into your
 system's Python distribution. This is usually a bad idea and you should
 follow the :ref:`nopython` instructions before installing pvlib.
 
-You may still want to download the Python source code so that you can
-easily get all of the Jupyter Notebook tutorials. Either clone the `git
+You may still want to download the Python source code. Either clone the `git
 repository <https://github.com/pvlib/pvlib-python>`_ or go to the
 `Releases page <https://github.com/pvlib/pvlib-python/releases>`_ to
-download the zip file of the most recent release. You can also use the
-nbviewer website to choose a tutorial to experiment with. Go to our
-`nbviewer tutorial page
-<http://nbviewer.jupyter.org/github/pvlib/pvlib-python/tree/main/docs/
-tutorials/>`_.
+download the zip file of the most recent release.
 
 
 .. _editablelibrary:
@@ -220,7 +215,7 @@ pvlib-python is compatible with Python 3.
 
 pvlib-python requires Pandas, Numpy, and SciPy. The minimum version requirements
 are specified in
-`setup.py <https://github.com/pvlib/pvlib-python/blob/main/setup.py>`_.
+`pyproject.toml <https://github.com/pvlib/pvlib-python/blob/main/pyproject.toml>`_.
 They are typically releases from several years ago.
 
 A handful of pvlib-python features require additional packages that must

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/user_guide/package_overview.rst

@@ -47,8 +47,8 @@ instructions on how to contribute. We really appreciate it!
 
 Credits
 -------
-The pvlib-python community thanks Sandia National Lab
-for developing PVLIB Matlab and for supporting
+The pvlib-python community thanks Sandia National Laboratories
+for developing PVLIB for Matlab and for supporting
 Rob Andrews of Calama Consulting to port the library to Python.
 Will Holmgren thanks the Department of Energy's Energy
 Efficiency and Renewable Energy Postdoctoral Fellowship Program

pvlib-0.10.5/docs/sphinx/source/whatsnew/v0.10.5.rst

@@ -0,0 +1,44 @@
+.. _whatsnew_01050:
+
+
+v0.10.5 (May 6, 2024)
+---------------------
+
+
+Bug fixes
+~~~~~~~~~
+* Compatibility with numpy 2.0. (:issue:`2026`, :pull:`2027`)
+* Improved reliability of :py:func:`pvlib.singlediode.bishop88_mpp`,
+  :py:func:`pvlib.singlediode.bishop88_i_from_v` and
+  :py:func:`pvlib.singlediode.bishop88_v_from_i` by improving the initial
+  guess for the newton and brentq algorithms. (:issue:`2013`, :pull:`2032`)
+* Corrected equation for Ixx0 in :py:func:`pvlib.pvsystem.sapm`. (:issue:`2016`, :pull:`2019`)
+* Fixed :py:func:`pvlib.pvsystem.retrieve_sam` silently ignoring the ``path`` parameter
+  when ``name`` was provided. Now an exception is raised requesting to only provide one
+  of the two parameters. (:issue:`2018`, :pull:`2020`)
+
+
+Documentation
+~~~~~~~~~~~~~
+* Fix variable name typo at
+  ``docs\examples\system-models\plot_oedi_9068.py``. (:pull:`1996`)
+* Remove "Comparison with PVLib for Matlab" page from the User Guide. (:issue:`2010`, :pull:`2012`)
+
+
+Requirements
+~~~~~~~~~~~~
+* Minimum version of Python increased from 3.7 to 3.8. (:issue:`1975`, :pull:`2029`)
+* Minimum version of scipy advanced from 1.5.0 to 1.6.0. (:pull:`2027`)
+
+
+Contributors
+~~~~~~~~~~~~
+* Cliff Hansen (:ghuser:`cwhanse`)
+* :ghuser:`apct69`
+* Mark Mikofski (:ghuser:`mikofski`)
+* Echedey Luis (:ghuser:`echedey-ls`)
+* Adam R. Jensen (:ghuser:`adamrjensen`)
+* Anton Driesse (:ghuser:`adriesse`)
+* Scott Meredith (:ghuser:`smmeredith`)
+* Alexander Morgan (:ghuser:`alexandermorgan`)
+* Kevin Anderson (:ghuser:`kandersolar`)

pvlib-0.10.4/docs/sphinx/source/whatsnew/v0.10.5.rst → pvlib-0.10.5/docs/sphinx/source/whatsnew/v0.11.0.rst

@@ -1,8 +1,12 @@
-.. _whatsnew_01050:
+.. _whatsnew_01100:
 
 
-v0.10.5 (Anticipated June 2024)
--------------------------------
+v0.11.0 (Anticipated June, 2024)
+--------------------------------
+
+
+Breaking changes
+~~~~~~~~~~~~~~~~
 
 
 Deprecations

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/whatsnew/v0.3.0.txt

@@ -69,7 +69,7 @@ Enhancements
 * Modify ``sapm`` documentation to clarify that it does
   not work with the CEC database. (:issue:`122`)
 * Adds citation information to the documentation. (:issue:`73`)
-* Updates the :ref:`comparison_pvlib_matlab` documentation. (:issue:`116`)
+* Updates the ``comparison_pvlib_matlab`` documentation. (:issue:`116`)
 
 
 Bug fixes

{pvlib-0.10.4 → pvlib-0.10.5}/docs/sphinx/source/whatsnew/v0.9.1.rst

@@ -14,7 +14,7 @@ Deprecations
   :py:class:`~pvlib.modelchain.ModelChain` interfaces, although note that the
   inputs do not directly translate. (:pull:`1401`)
 * All functionality in the ``pvlib.forecast`` module is deprecated.
-  For details, see :ref:`forecasts`. (:issue:`1057`, :pull:`1426`)
+  For details, see ``forecasts``. (:issue:`1057`, :pull:`1426`)
 
 Enhancements
 ~~~~~~~~~~~~

{pvlib-0.10.4 → pvlib-0.10.5}/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.10.5.rst
 .. include:: whatsnew/v0.10.4.rst
 .. include:: whatsnew/v0.10.3.rst
 .. include:: whatsnew/v0.10.2.rst

{pvlib-0.10.4 → pvlib-0.10.5}/pvlib/bifacial/utils.py

@@ -4,6 +4,7 @@ modeling.
 """
 import numpy as np
 from pvlib.tools import sind, cosd, tand
+from scipy.integrate import trapezoid
 
 
 def _solar_projection_tangent(solar_zenith, solar_azimuth, surface_azimuth):
@@ -220,7 +221,7 @@ def vf_ground_sky_2d_integ(surface_tilt, gcr, height, pitch, max_rows=10,
             vf = vf_ground_sky_2d(r, gcr, z, pitch, height, max_rows)
             fz_sky[:, k] = vf[:, 0]  # remove spurious rotation dimension
     # calculate the integrated view factor for all of the ground between rows
-    return np.trapz(fz_sky, z, axis=0)
+    return trapezoid(fz_sky, z, axis=0)
 
 
 def _vf_poly(surface_tilt, gcr, x, delta):

{pvlib-0.10.4 → pvlib-0.10.5}/pvlib/iotools/srml.py

@@ -92,7 +92,7 @@ def read_srml(filename, map_variables=True):
     # Mask data marked with quality flag 99 (bad or missing data)
     for col in columns[::2]:
         missing = data[col + '_flag'] == 99
-        data[col] = data[col].where(~(missing), np.NaN)
+        data[col] = data[col].where(~(missing), np.nan)
     return data
 
 
@@ -175,7 +175,8 @@ def _format_index(df):
 @deprecated('0.10.0', alternative='pvlib.iotools.get_srml', removal='0.11.0')
 def read_srml_month_from_solardat(station, year, month, filetype='PO',
                                   map_variables=True):
-    """Request a month of SRML data and read it into a Dataframe.
+    """
+    Request a month of SRML data and read it into a Dataframe.
 
     The SRML is described in [1]_.
 

{pvlib-0.10.4 → pvlib-0.10.5}/pvlib/iotools/surfrad.py

@@ -152,7 +152,7 @@ def read_surfrad(filename, map_variables=True):
 
     data = _format_index(data)
     missing = data == -9999.9
-    data = data.where(~missing, np.NaN)
+    data = data.where(~missing, np.nan)
 
     if map_variables:
         data.rename(columns=VARIABLE_MAP, inplace=True)

{pvlib-0.10.4 → pvlib-0.10.5}/pvlib/location.py

@@ -439,8 +439,10 @@ def lookup_altitude(latitude, longitude):
     # 255 is a special value that means nodata. Fallback to 0 if nodata.
     if alt == 255:
         return 0
+    # convert from np.uint8 to float so that the following operations succeed
+    alt = float(alt)
     # Altitude is encoded in 28 meter steps from -450 meters to 6561 meters
     # There are 0-254 possible altitudes, with 255 reserved for nodata.
     alt *= 28
     alt -= 450
-    return float(alt)
+    return alt

{pvlib-0.10.4 → pvlib-0.10.5}/pvlib/pvarray.py

@@ -311,11 +311,13 @@ def huld(effective_irradiance, temp_mod, pdc0, k=None, cell_type=None):
 
     :py:func:`huld` is a component of the PV performance model implemented in
     PVGIS. Among other components, the full PVGIS model includes:
-        - the Faiman model for module temperature
-          :py:func:`pvlib.temperature.faiman`
-        - the Martin and Ruiz model for the incidence angle modifier (IAM)
-          :py:func:`pvlib.iam.martin_ruiz`
-        - a custom model for a spectral adjustment factor
+
+    - the Faiman model for module temperature
+      :py:func:`pvlib.temperature.faiman`
+    - the Martin and Ruiz model for the incidence angle modifier (IAM)
+      :py:func:`pvlib.iam.martin_ruiz`
+    - a custom model for a spectral adjustment factor
+
     The PVGIS API (see :py:func:`pvlib.iotools.get_pvgis_hourly`) returns
     broadband plane-of-array irradiance (``poa_global``) and DC power (``P``).
     ``poa_global`` is irradiance before applying the IAM and spectral

{pvlib-0.10.4 → pvlib-0.10.5}/pvlib/pvsystem.py

@@ -7,7 +7,7 @@ from collections import OrderedDict
 import functools
 import io
 import itertools
-import os
+from pathlib import Path
 import inspect
 from urllib.request import urlopen
 import numpy as np
@@ -1487,8 +1487,10 @@ def calcparams_desoto(effective_irradiance, temp_cell,
     '''
     Calculates five parameter values for the single diode equation at
     effective irradiance and cell temperature using the De Soto et al.
-    model described in [1]_. The five values returned by calcparams_desoto
-    can be used by singlediode to calculate an IV curve.
+    model. The five values returned by ``calcparams_desoto`` can be used by
+    singlediode to calculate an IV curve.
+
+    The model is described in [1]_.
 
     Parameters
     ----------
@@ -1958,9 +1960,9 @@ def calcparams_pvsyst(effective_irradiance, temp_cell,
 
 
 def retrieve_sam(name=None, path=None):
-    '''
-    Retrieve latest module and inverter info from a local file or the
-    SAM website.
+    """
+    Retrieve latest module and inverter info from a file bundled with pvlib,
+    a path or an URL (like SAM's website).
 
     This function will retrieve either:
 
@@ -1971,10 +1973,14 @@ def retrieve_sam(name=None, path=None):
 
     and return it as a pandas DataFrame.
 
+    .. note::
+        Only provide one of ``name`` or ``path``.
+
     Parameters
     ----------
     name : string, optional
-        Name can be one of:
+        Use one of the following strings to retrieve a database bundled with
+        pvlib:
 
         * 'CECMod' - returns the CEC module database
         * 'CECInverter' - returns the CEC Inverter database
@@ -1985,7 +1991,7 @@ def retrieve_sam(name=None, path=None):
         * 'ADRInverter' - returns the ADR Inverter database
 
     path : string, optional
-        Path to the SAM file. May also be a URL.
+        Path to a CSV file or a URL.
 
     Returns
     -------
@@ -1997,7 +2003,11 @@ def retrieve_sam(name=None, path=None):
     Raises
     ------
     ValueError
-        If no name or path is provided.
+        If no ``name`` or ``path`` is provided.
+    ValueError
+        If both ``name`` and ``path`` are provided.
+    KeyError
+        If the provided ``name`` is not a valid database name.
 
     Notes
     -----
@@ -2030,38 +2040,38 @@ def retrieve_sam(name=None, path=None):
     CEC_Date                     NaN
     CEC_Type     Utility Interactive
     Name: AE_Solar_Energy__AE6_0__277V_, dtype: object
-    '''
-
-    if name is not None:
-        name = name.lower()
-        data_path = os.path.join(
-            os.path.dirname(os.path.abspath(__file__)), 'data')
-        if name == 'cecmod':
-            csvdata = os.path.join(
-                data_path, 'sam-library-cec-modules-2019-03-05.csv')
-        elif name == 'sandiamod':
-            csvdata = os.path.join(
-                data_path, 'sam-library-sandia-modules-2015-6-30.csv')
-        elif name == 'adrinverter':
-            csvdata = os.path.join(
-                data_path, 'adr-library-cec-inverters-2019-03-05.csv')
-        elif name in ['cecinverter', 'sandiainverter']:
-            # Allowing either, to provide for old code,
-            # while aligning with current expectations
-            csvdata = os.path.join(
-                data_path, 'sam-library-cec-inverters-2019-03-05.csv')
-        else:
-            raise ValueError(f'invalid name {name}')
-    elif path is not None:
-        if path.startswith('http'):
-            response = urlopen(path)
-            csvdata = io.StringIO(response.read().decode(errors='ignore'))
-        else:
-            csvdata = path
+    """
+    # error: path was previously silently ignored if name was given GH#2018
+    if name is not None and path is not None:
+        raise ValueError("Please provide either 'name' or 'path', not both.")
     elif name is None and path is None:
-        raise ValueError("A name or path must be provided!")
-
-    return _parse_raw_sam_df(csvdata)
+        raise ValueError("Please provide either 'name' or 'path'.")
+    elif name is not None:
+        internal_dbs = {
+            "cecmod": "sam-library-cec-modules-2019-03-05.csv",
+            "sandiamod": "sam-library-sandia-modules-2015-6-30.csv",
+            "adrinverter": "adr-library-cec-inverters-2019-03-05.csv",
+            # Both 'cecinverter' and 'sandiainverter', point to same database
+            # to provide for old code, while aligning with current expectations
+            "cecinverter": "sam-library-cec-inverters-2019-03-05.csv",
+            "sandiainverter": "sam-library-cec-inverters-2019-03-05.csv",
+        }
+        try:
+            csvdata_path = Path(__file__).parent.joinpath(
+                "data", internal_dbs[name.lower()]
+            )
+        except KeyError:
+            raise KeyError(
+                f"Invalid name {name}. "
+                + f"Provide one of {list(internal_dbs.keys())}."
+            ) from None
+    else:  # path is not None
+        if path.lower().startswith("http"):  # URL check is not case-sensitive
+            response = urlopen(path)  # URL is case-sensitive
+            csvdata_path = io.StringIO(response.read().decode(errors="ignore"))
+        else:
+            csvdata_path = path
+    return _parse_raw_sam_df(csvdata_path)
 
 
 def _normalize_sam_product_names(names):
@@ -2254,10 +2264,9 @@ def sapm(effective_irradiance, temp_cell, module):
         module['IXO'] * (module['C4']*Ee + module['C5']*(Ee**2)) *
         (1 + module['Aisc']*(temp_cell - temp_ref)))
 
-    # the Ixx calculation in King 2004 has a typo (mixes up Aisc and Aimp)
     out['i_xx'] = (
         module['IXXO'] * (module['C6']*Ee + module['C7']*(Ee**2)) *
-        (1 + module['Aisc']*(temp_cell - temp_ref)))
+        (1 + module['Aimp']*(temp_cell - temp_ref)))
 
     if isinstance(out['i_sc'], pd.Series):
         out = pd.DataFrame(out)
@@ -2536,7 +2545,7 @@ def singlediode(photocurrent, saturation_current, resistance_series,
 
 
 def max_power_point(photocurrent, saturation_current, resistance_series,
-                    resistance_shunt, nNsVth, d2mutau=0, NsVbi=np.Inf,
+                    resistance_shunt, nNsVth, d2mutau=0, NsVbi=np.inf,
                     method='brentq'):
     """
     Given the single diode equation coefficients, calculates the maximum power

{pvlib-0.10.4 → pvlib-0.10.5}/pvlib/scaling.py

@@ -13,8 +13,10 @@ from scipy.spatial.distance import pdist
 def wvm(clearsky_index, positions, cloud_speed, dt=None):
     """
     Compute spatial aggregation time series smoothing on clear sky index based
-    on the Wavelet Variability model of Lave et al. [1]_, [2]_. Implementation
-    is basically a port of the Matlab version of the code [3]_.
+    on the Wavelet Variability model.
+
+    This model is described in Lave et al. [1]_, [2]_.
+    Implementation is basically a port of the Matlab version of the code [3]_.
 
     Parameters
     ----------