pvlib 0.10.5__py3-none-any.whl → 0.11.0a1__py3-none-any.whl

pvlib/location.py

@@ -4,7 +4,7 @@ This module contains the Location class.
 
 # Will Holmgren, University of Arizona, 2014-2016.
 
-import os
+import pathlib
 import datetime
 
 import pandas as pd
@@ -14,6 +14,7 @@ import h5py
 from pvlib import solarposition, clearsky, atmosphere, irradiance
 from pvlib.tools import _degrees_to_index
 
+
 class Location:
     """
     Location objects are convenient containers for latitude, longitude,
@@ -44,8 +45,11 @@ class Location:
         pytz.timezone objects will be converted to strings.
         ints and floats must be in hours from UTC.
 
-    altitude : float, default 0.
+    altitude : float, optional
         Altitude from sea level in meters.
+        If not specified, the altitude will be fetched from
+        :py:func:`pvlib.location.lookup_altitude`.
+        If no data is available for the location, the altitude is set to 0.
 
     name : string, optional
         Sets the name attribute of the Location object.
@@ -55,7 +59,8 @@ class Location:
     pvlib.pvsystem.PVSystem
     """
 
-    def __init__(self, latitude, longitude, tz='UTC', altitude=0, name=None):
+    def __init__(self, latitude, longitude, tz='UTC', altitude=None,
+                 name=None):
 
         self.latitude = latitude
         self.longitude = longitude
@@ -75,6 +80,9 @@ class Location:
         else:
             raise TypeError('Invalid tz specification')
 
+        if altitude is None:
+            altitude = lookup_altitude(latitude, longitude)
+
         self.altitude = altitude
 
         self.name = name
@@ -427,8 +435,8 @@ def lookup_altitude(latitude, longitude):
 
     """
 
-    pvlib_path = os.path.dirname(os.path.abspath(__file__))
-    filepath = os.path.join(pvlib_path, 'data', 'Altitude.h5')
+    pvlib_path = pathlib.Path(__file__).parent
+    filepath = pvlib_path / 'data' / 'Altitude.h5'
 
     latitude_index = _degrees_to_index(latitude, coordinate='latitude')
     longitude_index = _degrees_to_index(longitude, coordinate='longitude')

pvlib/modelchain.py

@@ -13,14 +13,11 @@ import pandas as pd
 from dataclasses import dataclass, field
 from typing import Union, Tuple, Optional, TypeVar
 
-from pvlib import (atmosphere, clearsky, inverter, pvsystem, solarposition,
-                   temperature, iam)
+from pvlib import pvsystem, iam
 import pvlib.irradiance  # avoid name conflict with full import
 from pvlib.pvsystem import _DC_MODEL_PARAMS
 from pvlib.tools import _build_kwargs
 
-from pvlib._deprecation import deprecated
-
 # keys that are used to detect input data and assign data to appropriate
 # ModelChain attribute
 # for ModelChain.weather
@@ -41,7 +38,7 @@ DATA_KEYS = WEATHER_KEYS + POA_KEYS + TEMPERATURE_KEYS
 
 # these dictionaries contain the default configuration for following
 # established modeling sequences. They can be used in combination with
-# basic_chain and ModelChain. They are used by the ModelChain methods
+# ModelChain, particularly they are used by the methods
 # ModelChain.with_pvwatts, ModelChain.with_sapm, etc.
 
 # pvwatts documentation states that it uses the following reference for
@@ -62,165 +59,6 @@ SAPM_CONFIG = dict(
 )
 
 
-@deprecated(
-    since='0.9.1',
-    name='pvlib.modelchain.basic_chain',
-    alternative=('pvlib.modelchain.ModelChain.with_pvwatts'
-                 ' or pvlib.modelchain.ModelChain.with_sapm'),
-    addendum='Note that the with_xyz methods take different model parameters.'
-)
-def basic_chain(times, latitude, longitude,
-                surface_tilt, surface_azimuth,
-                module_parameters, temperature_model_parameters,
-                inverter_parameters,
-                irradiance=None, weather=None,
-                transposition_model='haydavies',
-                solar_position_method='nrel_numpy',
-                airmass_model='kastenyoung1989',
-                altitude=None, pressure=None,
-                **kwargs):
-    """
-    An experimental function that computes all of the modeling steps
-    necessary for calculating power or energy for a PV system at a given
-    location.
-
-    Parameters
-    ----------
-    times : DatetimeIndex
-        Times at which to evaluate the model.
-
-    latitude : float.
-        Positive is north of the equator.
-        Use decimal degrees notation.
-
-    longitude : float.
-        Positive is east of the prime meridian.
-        Use decimal degrees notation.
-
-    surface_tilt : numeric
-        Surface tilt angles in decimal degrees.
-        The tilt angle is defined as degrees from horizontal
-        (e.g. surface facing up = 0, surface facing horizon = 90)
-
-    surface_azimuth : numeric
-        Surface azimuth angles in decimal degrees.
-        The azimuth convention is defined
-        as degrees east of north
-        (North=0, South=180, East=90, West=270).
-
-    module_parameters : dict or Series
-        Module parameters as defined by the SAPM. See pvsystem.sapm for
-        details.
-
-    temperature_model_parameters : dict or Series
-        Temperature model parameters as defined by the SAPM.
-        See temperature.sapm_cell for details.
-
-    inverter_parameters : dict or Series
-        Inverter parameters as defined by the CEC. See
-        :py:func:`inverter.sandia` for details.
-
-    irradiance : DataFrame, optional
-        If not specified, calculates clear sky data.
-        Columns must be 'dni', 'ghi', 'dhi'.
-
-    weather : DataFrame, optional
-        If not specified, assumes air temperature is 20 C and
-        wind speed is 0 m/s.
-        Columns must be 'wind_speed', 'temp_air'.
-
-    transposition_model : str, default 'haydavies'
-        Passed to system.get_irradiance.
-
-    solar_position_method : str, default 'nrel_numpy'
-        Passed to solarposition.get_solarposition.
-
-    airmass_model : str, default 'kastenyoung1989'
-        Passed to atmosphere.relativeairmass.
-
-    altitude : float, optional
-        If not specified, computed from ``pressure``. Assumed to be 0 m
-        if ``pressure`` is also unspecified.
-
-    pressure : float, optional
-        If not specified, computed from ``altitude``. Assumed to be 101325 Pa
-        if ``altitude`` is also unspecified.
-
-    **kwargs
-        Arbitrary keyword arguments.
-        See code for details.
-
-    Returns
-    -------
-    output : (dc, ac)
-        Tuple of DC power (with SAPM parameters) (DataFrame) and AC
-        power (Series).
-    """
-
-    if altitude is None and pressure is None:
-        altitude = 0.
-        pressure = 101325.
-    elif altitude is None:
-        altitude = atmosphere.pres2alt(pressure)
-    elif pressure is None:
-        pressure = atmosphere.alt2pres(altitude)
-
-    solar_position = solarposition.get_solarposition(
-        times, latitude, longitude, altitude=altitude, pressure=pressure,
-        method=solar_position_method, **kwargs)
-
-    # possible error with using apparent zenith with some models
-    airmass = atmosphere.get_relative_airmass(
-        solar_position['apparent_zenith'], model=airmass_model)
-    airmass = atmosphere.get_absolute_airmass(airmass, pressure)
-    dni_extra = pvlib.irradiance.get_extra_radiation(solar_position.index)
-
-    aoi = pvlib.irradiance.aoi(surface_tilt, surface_azimuth,
-                               solar_position['apparent_zenith'],
-                               solar_position['azimuth'])
-
-    if irradiance is None:
-        linke_turbidity = clearsky.lookup_linke_turbidity(
-            solar_position.index, latitude, longitude)
-        irradiance = clearsky.ineichen(
-            solar_position['apparent_zenith'],
-            airmass,
-            linke_turbidity,
-            altitude=altitude,
-            dni_extra=dni_extra
-        )
-
-    total_irrad = pvlib.irradiance.get_total_irradiance(
-        surface_tilt,
-        surface_azimuth,
-        solar_position['apparent_zenith'],
-        solar_position['azimuth'],
-        irradiance['dni'],
-        irradiance['ghi'],
-        irradiance['dhi'],
-        model=transposition_model,
-        dni_extra=dni_extra)
-
-    if weather is None:
-        weather = {'wind_speed': 0, 'temp_air': 20}
-
-    cell_temperature = temperature.sapm_cell(
-        total_irrad['poa_global'], weather['temp_air'], weather['wind_speed'],
-        temperature_model_parameters['a'], temperature_model_parameters['b'],
-        temperature_model_parameters['deltaT'])
-
-    effective_irradiance = pvsystem.sapm_effective_irradiance(
-        total_irrad['poa_direct'], total_irrad['poa_diffuse'], airmass, aoi,
-        module_parameters)
-
-    dc = pvsystem.sapm(effective_irradiance, cell_temperature,
-                       module_parameters)
-
-    ac = inverter.sandia(dc['v_mp'], dc['p_mp'], inverter_parameters)
-
-    return dc, ac
-
-
 def get_orientation(strategy, **kwargs):
     """
     Determine a PV system's surface tilt and surface azimuth
@@ -238,7 +76,6 @@ def get_orientation(strategy, **kwargs):
     -------
     surface_tilt, surface_azimuth
     """
-
     if strategy == 'south_at_latitude_tilt':
         surface_azimuth = 180
         surface_tilt = kwargs['latitude']

pvlib/pvsystem.py

@@ -19,6 +19,7 @@ from typing import Optional, Union
 
 from pvlib._deprecation import deprecated, warn_deprecated
 
+import pvlib  # used to avoid albedo name collision in the Array class
 from pvlib import (atmosphere, iam, inverter, irradiance,
                    singlediode as _singlediode, spectrum, temperature)
 from pvlib.tools import _build_kwargs, _build_args
@@ -131,13 +132,13 @@ class PVSystem:
 
     albedo : float, optional
         Ground surface albedo. If not supplied, then ``surface_type`` is used
-        to look up a value in ``irradiance.SURFACE_ALBEDOS``.
+        to look up a value in  :py:const:`pvlib.albedo.SURFACE_ALBEDOS`.
         If ``surface_type`` is also not supplied then a ground surface albedo
         of 0.25 is used.
 
     surface_type : string, optional
-        The ground surface type. See ``irradiance.SURFACE_ALBEDOS`` for
-        valid values.
+        The ground surface type. See  :py:const:`pvlib.albedo.SURFACE_ALBEDOS`
+        for valid values.
 
     module : string, optional
         The model name of the modules.
@@ -721,15 +722,13 @@ class PVSystem:
         )
 
     def singlediode(self, photocurrent, saturation_current,
-                    resistance_series, resistance_shunt, nNsVth,
-                    ivcurve_pnts=None):
+                    resistance_series, resistance_shunt, nNsVth):
         """Wrapper around the :py:func:`pvlib.pvsystem.singlediode` function.
 
         See :py:func:`pvsystem.singlediode` for details
         """
         return singlediode(photocurrent, saturation_current,
-                           resistance_series, resistance_shunt, nNsVth,
-                           ivcurve_pnts=ivcurve_pnts)
+                           resistance_series, resistance_shunt, nNsVth)
 
     def i_from_v(self, voltage, photocurrent, saturation_current,
                  resistance_series, resistance_shunt, nNsVth):
@@ -907,13 +906,13 @@ class Array:
 
     albedo : float, optional
         Ground surface albedo. If not supplied, then ``surface_type`` is used
-        to look up a value in ``irradiance.SURFACE_ALBEDOS``.
+        to look up a value in  :py:const:`pvlib.albedo.SURFACE_ALBEDOS`.
         If ``surface_type`` is also not supplied then a ground surface albedo
         of 0.25 is used.
 
     surface_type : string, optional
-        The ground surface type. See ``irradiance.SURFACE_ALBEDOS`` for valid
-        values.
+        The ground surface type. See  :py:const:`pvlib.albedo.SURFACE_ALBEDOS`
+        for valid values.
 
     module : string, optional
         The model name of the modules.
@@ -956,7 +955,7 @@ class Array:
 
         self.surface_type = surface_type
         if albedo is None:
-            self.albedo = irradiance.SURFACE_ALBEDOS.get(surface_type, 0.25)
+            self.albedo = pvlib.albedo.SURFACE_ALBEDOS.get(surface_type, 0.25)
         else:
             self.albedo = albedo
 
@@ -2318,9 +2317,10 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi,
     a module's cells.
 
     The model is
+
     .. math::
 
-        `Ee = f_1(AM_a) (E_b f_2(AOI) + f_d E_d)`
+        Ee = f_1(AM_a) (E_b f_2(AOI) + f_d E_d)
 
     where :math:`Ee` is effective irradiance (W/m2), :math:`f_1` is a fourth
     degree polynomial in air mass :math:`AM_a`, :math:`E_b` is beam (direct)
@@ -2350,8 +2350,7 @@ def sapm_effective_irradiance(poa_direct, poa_diffuse, airmass_absolute, aoi,
 
 
 def singlediode(photocurrent, saturation_current, resistance_series,
-                resistance_shunt, nNsVth, ivcurve_pnts=None,
-                method='lambertw'):
+                resistance_shunt, nNsVth, method='lambertw'):
     r"""
     Solve the single diode equation to obtain a photovoltaic IV curve.
 
@@ -2403,14 +2402,6 @@ def singlediode(photocurrent, saturation_current, resistance_series,
         junction in Kelvin, and :math:`q` is the charge of an electron
         (coulombs). ``0 < nNsVth``.  [V]
 
-    ivcurve_pnts : int, optional
-        Number of points in the desired IV curve. If not specified or 0, no
-        points on the IV curves will be produced.
-
-        .. deprecated:: 0.10.0
-           Use :py:func:`pvlib.pvsystem.v_from_i` and
-           :py:func:`pvlib.pvsystem.i_from_v` instead.
-
     method : str, default 'lambertw'
         Determines the method used to calculate points on the IV curve. The
         options are ``'lambertw'``, ``'newton'``, or ``'brentq'``.
@@ -2420,20 +2411,15 @@ def singlediode(photocurrent, saturation_current, resistance_series,
     dict or pandas.DataFrame
         The returned dict-like object always contains the keys/columns:
 
-            * i_sc - short circuit current in amperes.
-            * v_oc - open circuit voltage in volts.
-            * i_mp - current at maximum power point in amperes.
-            * v_mp - voltage at maximum power point in volts.
-            * p_mp - power at maximum power point in watts.
-            * i_x - current, in amperes, at ``v = 0.5*v_oc``.
-            * i_xx - current, in amperes, at ``v = 0.5*(v_oc+v_mp)``.
+        * i_sc - short circuit current in amperes.
+        * v_oc - open circuit voltage in volts.
+        * i_mp - current at maximum power point in amperes.
+        * v_mp - voltage at maximum power point in volts.
+        * p_mp - power at maximum power point in watts.
+        * i_x - current, in amperes, at ``v = 0.5*v_oc``.
+        * i_xx - current, in amperes, at ``v = 0.5*(v_oc+v_mp)``.
 
-        A dict is returned when the input parameters are scalars or
-        ``ivcurve_pnts > 0``. If ``ivcurve_pnts > 0``, the output dictionary
-        will also include the keys:
-
-            * i - IV curve current in amperes.
-            * v - IV curve voltage in volts.
+        A dict is returned when the input parameters are scalars.
 
     See also
     --------
@@ -2457,13 +2443,6 @@ def singlediode(photocurrent, saturation_current, resistance_series,
     that guarantees convergence by bounding the voltage between zero and
     open-circuit.
 
-    If the method is either ``'newton'`` or ``'brentq'`` and ``ivcurve_pnts``
-    are indicated, then :func:`pvlib.singlediode.bishop88` [4]_ is used to
-    calculate the points on the IV curve points at diode voltages from zero to
-    open-circuit voltage with a log spacing that gets closer as voltage
-    increases. If the method is ``'lambertw'`` then the calculated points on
-    the IV curve are linearly spaced.
-
     References
     ----------
     .. [1] S.R. Wenham, M.A. Green, M.E. Watt, "Applied Photovoltaics" ISBN
@@ -2480,21 +2459,13 @@ def singlediode(photocurrent, saturation_current, resistance_series,
        photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
        https://doi.org/10.1016/0379-6787(88)90059-2
     """
-    if ivcurve_pnts:
-        warn_deprecated('0.10.0', name='pvlib.pvsystem.singlediode',
-                        alternative=('pvlib.pvsystem.v_from_i and '
-                                     'pvlib.pvsystem.i_from_v'),
-                        obj_type='parameter ivcurve_pnts',
-                        removal='0.11.0')
     args = (photocurrent, saturation_current, resistance_series,
             resistance_shunt, nNsVth)  # collect args
     # Calculate points on the IV curve using the LambertW solution to the
     # single diode equation
     if method.lower() == 'lambertw':
-        out = _singlediode._lambertw(*args, ivcurve_pnts)
+        out = _singlediode._lambertw(*args)
         points = out[:7]
-        if ivcurve_pnts:
-            ivcurve_i, ivcurve_v = out[7:]
     else:
         # Calculate points on the IV curve using either 'newton' or 'brentq'
         # methods. Voltages are determined by first solving the single diode
@@ -2516,21 +2487,10 @@ def singlediode(photocurrent, saturation_current, resistance_series,
         )
         points = i_sc, v_oc, i_mp, v_mp, p_mp, i_x, i_xx
 
-        # calculate the IV curve if requested using bishop88
-        if ivcurve_pnts:
-            vd = v_oc * (
-                (11.0 - np.logspace(np.log10(11.0), 0.0, ivcurve_pnts)) / 10.0
-            )
-            ivcurve_i, ivcurve_v, _ = _singlediode.bishop88(vd, *args)
-
     columns = ('i_sc', 'v_oc', 'i_mp', 'v_mp', 'p_mp', 'i_x', 'i_xx')
 
-    if all(map(np.isscalar, args)) or ivcurve_pnts:
+    if all(map(np.isscalar, args)):
         out = {c: p for c, p in zip(columns, points)}
-
-        if ivcurve_pnts:
-            out.update(i=ivcurve_i, v=ivcurve_v)
-
         return out
 
     points = np.atleast_1d(*points)  # convert scalars to 1d-arrays