Merge branch 'main' into dataset-retrieve-function

pvlib · echedey-ls · Jun 7, 2023 · Jun 7, 2023 · Jun 7, 2023 · Jun 8, 2023
commit 586381ad091d19b53a410cb1701f8881d8cd3edb
diff --git a/docs/sphinx/source/whatsnew/v0.10.0.rst b/docs/sphinx/source/whatsnew/v0.10.0.rst
@@ -77,6 +77,54 @@ Enhancements
 * Add :py:func:`pvlib.tools.locate_example_dataset` to get example and test
   files under `pvlib/data` path.
   (:issue:`924`, :pull:`1763`)
+* Added two new irradiance decomposition models: :py:func:`pvlib.irradiance.orgill_hollands` (:pull:`1730`)
+  and :py:func:`pvlib.irradiance.louche` (:pull:`1705`).
+* The return values of :py:func:`pvlib.pvsystem.calcparams_desoto`,
+  :py:func:`pvlib.pvsystem.calcparams_cec`, and
+  :py:func:`pvlib.pvsystem.calcparams_pvsyst` are all numeric types and have
+  the same Python type as the ``effective_irradiance`` and ``temp_cell`` parameters. (:issue:`1626`, :pull:`1700`)
+* Added ``map_variables`` parameter to :py:func:`pvlib.iotools.read_tmy3` (:issue:`1517`, :pull:`1623`),
+  :py:func:`pvlib.iotools.read_srml`, and :py:func:`pvlib.iotools.read_srml_month_from_solardat` (:pull:`1773`).
+* Added :func:`pvlib.iotools.get_srml` that is similar to
+  :func:`pvlib.iotools.read_srml_month_from_solardat` but is able to fetch multiple months
+  of data using the ``start`` and ``end`` parameters.
+  (:pull:`1779`)
+* Allow passing keyword arguments to :py:func:`scipy:scipy.optimize.brentq` and
+  :py:func:`scipy:scipy.optimize.newton` solvers in
+  :py:func:`~pvlib.singlediode.bishop88_mpp`,
+  :py:func:`~pvlib.singlediode.bishop88_i_from_v` and
+  :py:func:`~pvlib.singlediode.bishop88_v_from_i`. Among others,
+  tolerance and number of iterations can be set.
+  (:issue:`1249`, :pull:`1764`)
+* Improved ``ModelChainResult.__repr__`` (:pull:`1236`)
+* Exposes several functions useful for bifacial and shading calculations (:pull:`1666`):
+
+  * :py:func:`pvlib.bifacial.utils.vf_row_sky_2d`
+  * :py:func:`pvlib.bifacial.utils.vf_row_sky_2d_integ`
+  * :py:func:`pvlib.bifacial.utils.vf_row_ground_2d`
+  * :py:func:`pvlib.bifacial.utils.vf_row_ground_2d_integ`
+  * :py:func:`pvlib.bifacial.utils.vf_ground_sky_2d`
+  * :py:func:`pvlib.bifacial.utils.vf_ground_sky_2d_integ`
+  * :py:func:`pvlib.shading.ground_angle`
+
+* Added a function :py:func:`pvlib.spectrum.spectral_factor_caballero`
+  to estimate spectral mismatch modifiers from atmospheric conditions. (:pull:`1296`)
+* Add optional ``encoding`` parameter to :py:func:`pvlib.iotools.read_tmy3`. (:issue:`1732`, :pull:`1737`)
+* Added function to retrieve horizon data from PVGIS 
+  :py:func:`pvlib.iotools.get_pvgis_horizon`. (:issue:`1290`, :pull:`1395`)
+* Update the URL used in the :py:func:`pvlib.iotools.get_cams` function. The new URL supports load-balancing
+  and redirects to the fastest server. (:issue:`1688`, :pull:`1740`)
+* :py:func:`pvlib.iotools.get_psm3` now has a ``url`` parameter to give the user
+  the option of controlling what NSRDB endpoint is used. (:pull:`1736`)
+* :py:func:`pvlib.iotools.get_psm3` now uses the new NSRDB 3.2.2 endpoint for
+  hourly and half-hourly single-year datasets. (:issue:`1591`, :pull:`1736`)
+* The default solar position algorithm (NREL SPA) is now 50-100% faster. (:pull:`1748`)
+* Added functions to retrieve daily precipitation, temperature, and snowfall data
+  from the NOAA's ACIS service: :py:func:`~pvlib.iotools.get_acis_prism`,
+  :py:func:`~pvlib.iotools.get_acis_nrcc`, :py:func:`~pvlib.iotools.get_acis_mpe`,
+  :py:func:`~pvlib.iotools.get_acis_station_data`, and
+  :py:func:`~pvlib.iotools.get_acis_available_stations`. (:issue:`1293`, :pull:`1767`)
+
 
 Bug fixes
 ~~~~~~~~~

diff --git a/pvlib/tests/test_tools.py b/pvlib/tests/test_tools.py
@@ -3,6 +3,7 @@
 import pvlib
 from pvlib import tools
 import numpy as np
+import pandas as pd
 import pathlib
 
 
@@ -99,6 +100,30 @@ def test_degrees_to_index_1():
         tools._degrees_to_index(degrees=22.0, coordinate='width')
 
 
+@pytest.mark.parametrize('args, args_idx', [
+    # no pandas.Series or pandas.DataFrame args
+    ((1,), None),
+    (([1],), None),
+    ((np.array(1),), None),
+    ((np.array([1]),), None),
+    # has pandas.Series or pandas.DataFrame args
+    ((pd.DataFrame([1], index=[1]),), 0),
+    ((pd.Series([1], index=[1]),), 0),
+    ((1, pd.Series([1], index=[1]),), 1),
+    ((1, pd.DataFrame([1], index=[1]),), 1),
+    # first pandas.Series or pandas.DataFrame is used
+    ((1, pd.Series([1], index=[1]), pd.DataFrame([2], index=[2]),), 1),
+    ((1, pd.DataFrame([1], index=[1]), pd.Series([2], index=[2]),), 1),
+])
+def test_get_pandas_index(args, args_idx):
+    index = tools.get_pandas_index(*args)
+
+    if args_idx is None:
+        assert index is None
+    else:
+        pd.testing.assert_index_equal(args[args_idx].index, index)
+
+
 def test_get_example_dataset_path_passes():
     expected_dataset = '723170TYA.CSV'
     assert pathlib.Path(pvlib.__path__[0], 'data',

diff --git a/pvlib/tools.py b/pvlib/tools.py
@@ -477,6 +477,28 @@ def _first_order_centered_difference(f, x0, dx=DX, args=()):
     return df / 2 / dx
 
 
+def get_pandas_index(*args):
+    """
+    Get the index of the first pandas DataFrame or Series in a list of
+    arguments.
+
+    Parameters
+    ----------
+    args: positional arguments
+        The numeric values to scan for a pandas index.
+
+    Returns
+    -------
+    A pandas index or None
+        None is returned if there are no pandas DataFrames or Series in the
+        args list.
+    """
+    return next(
+        (a.index for a in args if isinstance(a, (pd.DataFrame, pd.Series))),
+        None
+    )
+
+
 def get_example_dataset_path(dataset):
     """
     Return a filepath to a dataset bundled with PVLIB with name `dataset`.