pvlib 0.9.5__py3-none-any.whl → 0.10.0__py3-none-any.whl

pvlib/tests/test_tracking.py

@@ -290,155 +290,6 @@ def test_low_sun_angles():
         assert_allclose(expected[k], v)
 
 
-def test_SingleAxisTracker_tracking():
-    with pytest.warns(pvlibDeprecationWarning):
-        system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
-                                            axis_azimuth=180, gcr=2.0/7.0,
-                                            backtrack=True)
-
-    apparent_zenith = pd.Series([30])
-    apparent_azimuth = pd.Series([135])
-
-    tracker_data = system.singleaxis(apparent_zenith, apparent_azimuth)
-
-    expect = pd.DataFrame({'aoi': 7.286245, 'surface_azimuth': 142.65730,
-                           'surface_tilt': 35.98741,
-                           'tracker_theta': -20.88121},
-                          index=[0], dtype=np.float64)
-    expect = expect[SINGLEAXIS_COL_ORDER]
-
-    assert_frame_equal(expect, tracker_data)
-
-    # results calculated using PVsyst
-    pvsyst_solar_azimuth = 7.1609
-    pvsyst_solar_height = 27.315
-    pvsyst_axis_tilt = 20.
-    pvsyst_axis_azimuth = 20.
-    with pytest.warns(pvlibDeprecationWarning):
-        pvsyst_system = tracking.SingleAxisTracker(
-            max_angle=60., axis_tilt=pvsyst_axis_tilt,
-            axis_azimuth=180+pvsyst_axis_azimuth, backtrack=False)
-    # the definition of azimuth is different from PYsyst
-    apparent_azimuth = pd.Series([180+pvsyst_solar_azimuth])
-    apparent_zenith = pd.Series([90-pvsyst_solar_height])
-    tracker_data = pvsyst_system.singleaxis(apparent_zenith, apparent_azimuth)
-    expect = pd.DataFrame({'aoi': 41.07852, 'surface_azimuth': 180-18.432,
-                           'surface_tilt': 24.92122,
-                           'tracker_theta': -15.18391},
-                          index=[0], dtype=np.float64)
-    expect = expect[SINGLEAXIS_COL_ORDER]
-
-    assert_frame_equal(expect, tracker_data)
-
-
-# see test_irradiance for more thorough testing
-def test_get_aoi():
-    with pytest.warns(pvlibDeprecationWarning):
-        system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
-                                            axis_azimuth=180, gcr=2.0/7.0,
-                                            backtrack=True)
-    surface_tilt = np.array([30, 0])
-    surface_azimuth = np.array([90, 270])
-    solar_zenith = np.array([70, 10])
-    solar_azimuth = np.array([100, 180])
-    out = system.get_aoi(surface_tilt, surface_azimuth,
-                         solar_zenith, solar_azimuth)
-    expected = np.array([40.632115, 10.])
-    assert_allclose(out, expected, atol=0.000001)
-
-
-def test_get_irradiance():
-    with pytest.warns(pvlibDeprecationWarning):
-        system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
-                                            axis_azimuth=180, gcr=2.0/7.0,
-                                            backtrack=True)
-    times = pd.date_range(start='20160101 1200-0700',
-                          end='20160101 1800-0700', freq='6H')
-    # latitude=32, longitude=-111
-    solar_position = pd.DataFrame(np.array(
-        [[55.36421554,  55.38851771,  34.63578446,  34.61148229,
-          172.32003763,  -3.44516534],
-         [96.50000401,  96.50000401,  -6.50000401,  -6.50000401,
-          246.91581654,  -3.56292888]]),
-        columns=['apparent_zenith', 'zenith', 'apparent_elevation',
-                 'elevation', 'azimuth', 'equation_of_time'],
-        index=times)
-    irrads = pd.DataFrame({'dni': [900, 0], 'ghi': [600, 0], 'dhi': [100, 0]},
-                          index=times)
-    solar_zenith = solar_position['apparent_zenith']
-    solar_azimuth = solar_position['azimuth']
-
-    # invalid warnings already generated in horizon test above,
-    # no need to clutter test output here
-    with np.errstate(invalid='ignore'):
-        tracker_data = system.singleaxis(solar_zenith, solar_azimuth)
-
-    # some invalid values in irradiance.py. not our problem here
-    with np.errstate(invalid='ignore'):
-        irradiance = system.get_irradiance(tracker_data['surface_tilt'],
-                                           tracker_data['surface_azimuth'],
-                                           solar_zenith,
-                                           solar_azimuth,
-                                           irrads['dni'],
-                                           irrads['ghi'],
-                                           irrads['dhi'])
-
-    expected = pd.DataFrame(data=np.array(
-        [[961.80070,   815.94490,   145.85580,   135.32820, 10.52757492],
-         [nan, nan, nan, nan, nan]]),
-                            columns=['poa_global', 'poa_direct',
-                                     'poa_diffuse', 'poa_sky_diffuse',
-                                     'poa_ground_diffuse'],
-                            index=times)
-
-    assert_frame_equal(irradiance, expected, check_less_precise=2)
-
-    # test with albedo as a Series
-    irrads['albedo'] = [0.5, 0.5]
-    with np.errstate(invalid='ignore'):
-        irradiance = system.get_irradiance(tracker_data['surface_tilt'],
-                                           tracker_data['surface_azimuth'],
-                                           solar_zenith,
-                                           solar_azimuth,
-                                           irrads['dni'],
-                                           irrads['ghi'],
-                                           irrads['dhi'],
-                                           albedo=irrads['albedo'])
-
-    expected = pd.Series(data=[21.05514984, nan], index=times,
-                         name='poa_ground_diffuse')
-
-    assert_series_equal(irradiance['poa_ground_diffuse'], expected,
-                        check_less_precise=2)
-
-
-
-def test_SingleAxisTracker___repr__():
-    with pytest.warns(pvlibDeprecationWarning):
-        system = tracking.SingleAxisTracker(
-            max_angle=45, gcr=.25, module='blah', inverter='blarg',
-            temperature_model_parameters={'a': -3.56})
-    expected = """SingleAxisTracker:
-  axis_tilt: 0
-  axis_azimuth: 0
-  max_angle: 45
-  backtrack: True
-  gcr: 0.25
-  cross_axis_tilt: 0.0
-  name: None
-  Array:
-    name: None
-    mount: SingleAxisTrackerMount(axis_tilt=0, axis_azimuth=0, max_angle=45, backtrack=True, gcr=0.25, cross_axis_tilt=0.0, racking_model=None, module_height=None)
-    module: blah
-    albedo: 0.25
-    module_type: None
-    temperature_model_parameters: {'a': -3.56}
-    strings: 1
-    modules_per_string: 1
-  inverter: blarg"""  # noqa: E501
-    assert system.__repr__() == expected
-
-
 def test_calc_axis_tilt():
     # expected values
     expected_axis_tilt = 2.239  # [degrees]

pvlib/tools.py

@@ -346,7 +346,7 @@ def _golden_sect_DataFrame(params, lower, upper, func, atol=1e-8):
 
     phim1 = (np.sqrt(5) - 1) / 2
 
-    df = params
+    df = params.copy()  # shallow copy to avoid modifying caller's dict
     df['VH'] = upper
     df['VL'] = lower
 
@@ -377,6 +377,9 @@ def _golden_sect_DataFrame(params, lower, upper, func, atol=1e-8):
     df['max'] = 0.5 * (df['V1'] + df['V2'])
     func_result = func(df, 'max')
     x = np.where(np.isnan(func_result), np.nan, df['max'])
+    if np.isscalar(df['max']):
+        # np.where always returns an ndarray, converting scalars to 0d-arrays
+        x = x.item()
 
     return func_result, x
 
@@ -469,3 +472,25 @@ def _first_order_centered_difference(f, x0, dx=DX, args=()):
     # removal in scipy 1.12.0
     df = f(x0+dx, *args) - f(x0-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
+    )

pvlib/tracking.py

@@ -2,275 +2,7 @@ import numpy as np
 import pandas as pd
 
 from pvlib.tools import cosd, sind, tand, acosd, asind
-from pvlib.pvsystem import (
-    PVSystem, Array, SingleAxisTrackerMount, _unwrap_single_value
-)
-from pvlib import irradiance, atmosphere
-from pvlib._deprecation import deprecated
-
-
-@deprecated('0.9.0', alternative='PVSystem with SingleAxisTrackerMount')
-class SingleAxisTracker(PVSystem):
-    """
-    A class for single-axis trackers that inherits the PV modeling methods from
-    :py:class:`~pvlib.pvsystem.PVSystem`. For details on calculating tracker
-    rotation see :py:func:`pvlib.tracking.singleaxis`.
-
-    Parameters
-    ----------
-    axis_tilt : float, default 0
-        The tilt of the axis of rotation (i.e, the y-axis defined by
-        ``axis_azimuth``) with respect to horizontal.
-        ``axis_tilt`` must be >= 0 and <= 90. [degree]
-
-    axis_azimuth : float, default 0
-        A value denoting the compass direction along which the axis of
-        rotation lies. Measured in decimal degrees east of north.
-
-    max_angle : float, default 90
-        A value denoting the maximum rotation angle, in decimal degrees,
-        of the one-axis tracker from its horizontal position (horizontal
-        if axis_tilt = 0). A max_angle of 90 degrees allows the tracker
-        to rotate to a vertical position to point the panel towards a
-        horizon. max_angle of 180 degrees allows for full rotation.
-
-    backtrack : bool, default True
-        Controls whether the tracker has the capability to "backtrack"
-        to avoid row-to-row shading. False denotes no backtrack
-        capability. True denotes backtrack capability.
-
-    gcr : float, default 2.0/7.0
-        A value denoting the ground coverage ratio of a tracker system
-        which utilizes backtracking; i.e. the ratio between the PV array
-        surface area to total ground area. A tracker system with modules
-        2 meters wide, centered on the tracking axis, with 6 meters
-        between the tracking axes has a gcr of 2/6=0.333. If gcr is not
-        provided, a gcr of 2/7 is default. gcr must be <=1.
-
-    cross_axis_tilt : float, default 0.0
-        The angle, relative to horizontal, of the line formed by the
-        intersection between the slope containing the tracker axes and a plane
-        perpendicular to the tracker axes. Cross-axis tilt should be specified
-        using a right-handed convention. For example, trackers with axis
-        azimuth of 180 degrees (heading south) will have a negative cross-axis
-        tilt if the tracker axes plane slopes down to the east and positive
-        cross-axis tilt if the tracker axes plane slopes down to the west. Use
-        :func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate
-        `cross_axis_tilt`. [degrees]
-
-    **kwargs
-        Passed to :py:class:`~pvlib.pvsystem.PVSystem`. If the `arrays`
-        parameter is specified it must have only a single Array. Furthermore
-        if a :py:class:`~pvlib.pvsystem.Array` is provided it must have
-        ``surface_tilt`` and ``surface_azimuth`` equal to None.
-
-    Raises
-    ------
-    ValueError
-        If more than one Array is specified.
-    ValueError
-        If an Array is provided with a surface tilt or azimuth not None.
-
-    See also
-    --------
-    pvlib.tracking.singleaxis
-    pvlib.tracking.calc_axis_tilt
-    pvlib.tracking.calc_cross_axis_tilt
-    """
-
-    def __init__(self, axis_tilt=0, axis_azimuth=0, max_angle=90,
-                 backtrack=True, gcr=2.0/7.0, cross_axis_tilt=0.0, **kwargs):
-
-        mount_kwargs = {
-            k: kwargs.pop(k) for k in ['racking_model', 'module_height']
-            if k in kwargs
-        }
-        mount = SingleAxisTrackerMount(axis_tilt, axis_azimuth, max_angle,
-                                       backtrack, gcr, cross_axis_tilt,
-                                       **mount_kwargs)
-
-        array_defaults = {
-            'albedo': None, 'surface_type': None, 'module': None,
-            'module_type': None, 'module_parameters': None,
-            'temperature_model_parameters': None,
-            'modules_per_string': 1,
-        }
-        array_kwargs = {
-            key: kwargs.get(key, array_defaults[key]) for key in array_defaults
-        }
-        # strings/strings_per_inverter is a special case
-        array_kwargs['strings'] = kwargs.get('strings_per_inverter', 1)
-
-        array = Array(mount=mount, **array_kwargs)
-        pass_through_kwargs = {  # other args to pass to PVSystem()
-            k: v for k, v in kwargs.items() if k not in array_defaults
-        }
-        # leave these in case someone is using them
-        self.axis_tilt = axis_tilt
-        self.axis_azimuth = axis_azimuth
-        self.max_angle = max_angle
-        self.backtrack = backtrack
-        self.gcr = gcr
-        self.cross_axis_tilt = cross_axis_tilt
-
-        pass_through_kwargs['surface_tilt'] = None
-        pass_through_kwargs['surface_azimuth'] = None
-
-        super().__init__(arrays=[array], **pass_through_kwargs)
-
-    def __repr__(self):
-        attrs = ['axis_tilt', 'axis_azimuth', 'max_angle', 'backtrack', 'gcr',
-                 'cross_axis_tilt']
-        sat_repr = ('SingleAxisTracker:\n  ' + '\n  '.join(
-            f'{attr}: {getattr(self, attr)}' for attr in attrs))
-        # get the parent PVSystem info
-        pvsystem_repr = super().__repr__()
-        # remove the first line (contains 'PVSystem: \n')
-        pvsystem_repr = '\n'.join(pvsystem_repr.split('\n')[1:])
-        return sat_repr + '\n' + pvsystem_repr
-
-    def singleaxis(self, apparent_zenith, apparent_azimuth):
-        """
-        Get tracking data. See :py:func:`pvlib.tracking.singleaxis` more
-        detail.
-
-        Parameters
-        ----------
-        apparent_zenith : float, 1d array, or Series
-            Solar apparent zenith angles in decimal degrees.
-
-        apparent_azimuth : float, 1d array, or Series
-            Solar apparent azimuth angles in decimal degrees.
-
-        Returns
-        -------
-        tracking data
-        """
-        tracking_data = singleaxis(apparent_zenith, apparent_azimuth,
-                                   self.axis_tilt, self.axis_azimuth,
-                                   self.max_angle, self.backtrack,
-                                   self.gcr, self.cross_axis_tilt)
-
-        return tracking_data
-
-    def get_aoi(self, surface_tilt, surface_azimuth, solar_zenith,
-                solar_azimuth):
-        """Get the angle of incidence on the system.
-
-        For a given set of solar zenith and azimuth angles, the
-        surface tilt and azimuth parameters are typically determined
-        by :py:meth:`~SingleAxisTracker.singleaxis`. The
-        :py:meth:`~SingleAxisTracker.singleaxis` method also returns
-        the angle of incidence, so this method is only needed
-        if using a different tracking algorithm.
-
-        Parameters
-        ----------
-        surface_tilt : numeric
-            Panel tilt from horizontal.
-        surface_azimuth : numeric
-            Panel azimuth from north
-        solar_zenith : float or Series.
-            Solar zenith angle.
-        solar_azimuth : float or Series.
-            Solar azimuth angle.
-
-        Returns
-        -------
-        aoi : Series
-            The angle of incidence in degrees from normal.
-        """
-
-        aoi = irradiance.aoi(surface_tilt, surface_azimuth,
-                             solar_zenith, solar_azimuth)
-        return aoi
-
-    @_unwrap_single_value
-    def get_irradiance(self, surface_tilt, surface_azimuth,
-                       solar_zenith, solar_azimuth, dni, ghi, dhi,
-                       albedo=None, dni_extra=None, airmass=None,
-                       model='haydavies',
-                       **kwargs):
-        """
-        Uses the :func:`irradiance.get_total_irradiance` function to
-        calculate the plane of array irradiance components on a tilted
-        surface defined by the input data and ``self.albedo``.
-
-        For a given set of solar zenith and azimuth angles, the
-        surface tilt and azimuth parameters are typically determined
-        by :py:meth:`~SingleAxisTracker.singleaxis`.
-
-        Parameters
-        ----------
-        surface_tilt : numeric
-            Panel tilt from horizontal.
-        surface_azimuth : numeric
-            Panel azimuth from north
-        solar_zenith : numeric
-            Solar zenith angle.
-        solar_azimuth : numeric
-            Solar azimuth angle.
-        dni : float or Series
-            Direct Normal Irradiance
-        ghi : float or Series
-            Global horizontal irradiance
-        dhi : float or Series
-            Diffuse horizontal irradiance
-        albedo : None, float or Series, default None
-            Ground surface albedo. [unitless]
-        dni_extra : float or Series, default None
-            Extraterrestrial direct normal irradiance
-        airmass : float or Series, default None
-            Airmass
-        model : String, default 'haydavies'
-            Irradiance model.
-
-        **kwargs
-            Passed to :func:`irradiance.get_total_irradiance`.
-
-        Returns
-        -------
-        poa_irradiance : DataFrame
-            Column names are: ``total, beam, sky, ground``.
-        """
-
-        # not needed for all models, but this is easier
-        if dni_extra is None:
-            dni_extra = irradiance.get_extra_radiation(solar_zenith.index)
-
-        if airmass is None:
-            airmass = atmosphere.get_relative_airmass(solar_zenith)
-
-        # SingleAxisTracker only supports a single Array, but we need the
-        # validate/iterate machinery so that single length tuple input/output
-        # is handled the same as PVSystem.get_irradiance. GH 1159
-        dni = self._validate_per_array(dni, system_wide=True)
-        ghi = self._validate_per_array(ghi, system_wide=True)
-        dhi = self._validate_per_array(dhi, system_wide=True)
-
-        if albedo is None:
-            # assign default albedo here because SingleAxisTracker
-            # initializes albedo to None
-            albedo = 0.25
-
-        albedo = self._validate_per_array(albedo, system_wide=True)
-
-        return tuple(
-            irradiance.get_total_irradiance(
-                surface_tilt,
-                surface_azimuth,
-                solar_zenith,
-                solar_azimuth,
-                dni, ghi, dhi,
-                dni_extra=dni_extra,
-                airmass=airmass,
-                model=model,
-                albedo=albedo,
-                **kwargs)
-            for array, dni, ghi, dhi, albedo in zip(
-                self.arrays, dni, ghi, dhi, albedo
-            )
-        )
+from pvlib import irradiance
 
 
 def singleaxis(apparent_zenith, apparent_azimuth,

{pvlib-0.9.5.dist-info → pvlib-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pvlib
-Version: 0.9.5
+Version: 0.10.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: pvlib python Developers
@@ -27,13 +27,11 @@ Requires-Dist: scipy (>=1.4.0)
 Requires-Dist: h5py
 Requires-Dist: importlib-metadata ; python_version < "3.8"
 Provides-Extra: all
-Requires-Dist: cftime (>=1.1.1) ; extra == 'all'
 Requires-Dist: cython ; extra == 'all'
 Requires-Dist: docutils (==0.15.2) ; extra == 'all'
 Requires-Dist: ephem ; extra == 'all'
 Requires-Dist: ipython ; extra == 'all'
 Requires-Dist: matplotlib ; extra == 'all'
-Requires-Dist: netcdf4 ; extra == 'all'
 Requires-Dist: nrel-pysam ; extra == 'all'
 Requires-Dist: numba ; extra == 'all'
 Requires-Dist: pillow ; extra == 'all'
@@ -46,7 +44,6 @@ Requires-Dist: pytest-remotedata ; extra == 'all'
 Requires-Dist: pytest-rerunfailures ; extra == 'all'
 Requires-Dist: pytest-timeout ; extra == 'all'
 Requires-Dist: requests-mock ; extra == 'all'
-Requires-Dist: siphon ; extra == 'all'
 Requires-Dist: sphinx (==4.5.0) ; extra == 'all'
 Requires-Dist: sphinx-gallery ; extra == 'all'
 Requires-Dist: sphinx-toggleprompt (>=0.0.5) ; extra == 'all'
@@ -59,20 +56,15 @@ Requires-Dist: pydata-sphinx-theme (==0.8.1) ; extra == 'doc'
 Requires-Dist: sphinx-gallery ; extra == 'doc'
 Requires-Dist: docutils (==0.15.2) ; extra == 'doc'
 Requires-Dist: pillow ; extra == 'doc'
-Requires-Dist: netcdf4 ; extra == 'doc'
-Requires-Dist: siphon ; extra == 'doc'
 Requires-Dist: sphinx-toggleprompt (>=0.0.5) ; extra == 'doc'
 Requires-Dist: pvfactors ; extra == 'doc'
 Provides-Extra: optional
 Requires-Dist: cython ; extra == 'optional'
 Requires-Dist: ephem ; extra == 'optional'
-Requires-Dist: netcdf4 ; extra == 'optional'
 Requires-Dist: nrel-pysam ; extra == 'optional'
 Requires-Dist: numba ; extra == 'optional'
 Requires-Dist: pvfactors ; extra == 'optional'
-Requires-Dist: siphon ; extra == 'optional'
 Requires-Dist: statsmodels ; extra == 'optional'
-Requires-Dist: cftime (>=1.1.1) ; extra == 'optional'
 Provides-Extra: test
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: pytest-cov ; extra == 'test'