pvlib 0.10.4__py3-none-any.whl → 0.11.0__py3-none-any.whl

pvlib/iam.py

@@ -592,10 +592,10 @@ def marion_diffuse(model, surface_tilt, **kwargs):
     iam : dict
         IAM values for each type of diffuse irradiance:
 
-            * 'sky': radiation from the sky dome (zenith <= 90)
-            * 'horizon': radiation from the region of the sky near the horizon
-              (89.5 <= zenith <= 90)
-            * 'ground': radiation reflected from the ground (zenith >= 90)
+        * 'sky': radiation from the sky dome (zenith <= 90)
+        * 'horizon': radiation from the region of the sky near the horizon
+          (89.5 <= zenith <= 90)
+        * 'ground': radiation reflected from the ground (zenith >= 90)
 
         See [1]_ for a detailed description of each class.
 
@@ -667,10 +667,10 @@ def marion_integrate(function, surface_tilt, region, num=None):
     region : {'sky', 'horizon', 'ground'}
         The region to integrate over. Must be one of:
 
-            * 'sky': radiation from the sky dome (zenith <= 90)
-            * 'horizon': radiation from the region of the sky near the horizon
-              (89.5 <= zenith <= 90)
-            * 'ground': radiation reflected from the ground (zenith >= 90)
+        * 'sky': radiation from the sky dome (zenith <= 90)
+        * 'horizon': radiation from the region of the sky near the horizon
+          (89.5 <= zenith <= 90)
+        * 'ground': radiation reflected from the ground (zenith >= 90)
 
         See [1]_ for a detailed description of each class.
 
@@ -678,8 +678,8 @@ def marion_integrate(function, surface_tilt, region, num=None):
         The number of increments in the zenith integration.
         If not specified, N will follow the values used in [1]_:
 
-            * 'sky' or 'ground': num = 180
-            * 'horizon': num = 1800
+        * 'sky' or 'ground': num = 180
+        * 'horizon': num = 1800
 
     Returns
     -------
@@ -1107,14 +1107,14 @@ def convert(source_name, source_params, target_name, weight=_sin_weight,
     source_params : dict
         A dictionary of parameters for the source model.
 
-            If source model is ``'ashrae'``, the dictionary must contain
-            the key ``'b'``.
+        If source model is ``'ashrae'``, the dictionary must contain
+        the key ``'b'``.
 
-            If source model is ``'martin_ruiz'``, the dictionary must
-            contain the key ``'a_r'``.
+        If source model is ``'martin_ruiz'``, the dictionary must
+        contain the key ``'a_r'``.
 
-            If source model is ``'physical'``, the dictionary must
-            contain the keys ``'n'``, ``'K'``, and ``'L'``.
+        If source model is ``'physical'``, the dictionary must
+        contain the keys ``'n'``, ``'K'``, and ``'L'``.
 
     target_name : str
         Name of the target model. Must be ``'ashrae'``, ``'martin_ruiz'``, or
@@ -1146,14 +1146,14 @@ def convert(source_name, source_params, target_name, weight=_sin_weight,
     dict
         Parameters for the target model.
 
-            If target model is ``'ashrae'``, the dictionary will contain
-            the key ``'b'``.
+        If target model is ``'ashrae'``, the dictionary will contain
+        the key ``'b'``.
 
-            If target model is ``'martin_ruiz'``, the dictionary will
-            contain the key ``'a_r'``.
+        If target model is ``'martin_ruiz'``, the dictionary will
+        contain the key ``'a_r'``.
 
-            If target model is ``'physical'``, the dictionary will
-            contain the keys ``'n'``, ``'K'``, and ``'L'``.
+        If target model is ``'physical'``, the dictionary will
+        contain the keys ``'n'``, ``'K'``, and ``'L'``.
 
     Note
     ----
@@ -1243,14 +1243,14 @@ def fit(measured_aoi, measured_iam, model_name, weight=_sin_weight, xtol=None):
     dict
         Parameters for target model.
 
-            If target model is ``'ashrae'``, the dictionary will contain
-            the key ``'b'``.
+        If target model is ``'ashrae'``, the dictionary will contain
+        the key ``'b'``.
 
-            If target model is ``'martin_ruiz'``, the dictionary will
-            contain the key ``'a_r'``.
+        If target model is ``'martin_ruiz'``, the dictionary will
+        contain the key ``'a_r'``.
 
-            If target model is ``'physical'``, the dictionary will
-            contain the keys ``'n'``, ``'K'``, and ``'L'``.
+        If target model is ``'physical'``, the dictionary will
+        contain the keys ``'n'``, ``'K'``, and ``'L'``.
 
     References
     ----------

pvlib/iotools/__init__.py

@@ -1,7 +1,6 @@
 from pvlib.iotools.tmy import read_tmy2, read_tmy3  # noqa: F401
 from pvlib.iotools.epw import read_epw, parse_epw  # noqa: F401
 from pvlib.iotools.srml import read_srml  # noqa: F401
-from pvlib.iotools.srml import read_srml_month_from_solardat  # noqa: F401
 from pvlib.iotools.srml import get_srml  # noqa: F401
 from pvlib.iotools.surfrad import read_surfrad  # noqa: F401
 from pvlib.iotools.midc import read_midc  # noqa: F401

pvlib/iotools/midc.py

@@ -20,15 +20,21 @@ import pandas as pd
 MIDC_VARIABLE_MAP = {
     'BMS': {
         'Global CMP22 (vent/cor) [W/m^2]': 'ghi',
-        'Direct NIP [W/m^2]': 'dni',
+        'Direct CHP1-1 [W/m^2]': 'dni_chp1',
+        # NIP was mapped to dni for pvlib<=0.10.5
+        'Direct NIP [W/m^2]': 'dni_nip',
         'Diffuse CM22-1 (vent/cor) [W/m^2]': 'dhi',
         'Avg Wind Speed @ 6ft [m/s]': 'wind_speed',
         'Tower Dry Bulb Temp [deg C]': 'temp_air',
         'Tower RH [%]': 'relative_humidity'},
     'UOSMRL': {
         'Global CMP22 [W/m^2]': 'ghi',
-        'Direct NIP [W/m^2]': 'dni',
-        'Diffuse Schenk [W/m^2]': 'dhi',
+        'Direct CHP1 [W/m^2]': 'dni_chp1',
+        'Diffuse [W/m^2]': 'dhi',
+        # NIP was mapped to dni for pvlib<=0.10.5
+        'Direct NIP [W/m^2]': 'dni_nip',
+        # Schenk was mapped to dhi for pvlib<=0.10.5
+        # 'Diffuse Schenk [W/m^2]': 'dhi',
         'Air Temperature [deg C]': 'temp_air',
         'Relative Humidity [%]': 'relative_humidity',
         'Avg Wind Speed @ 10m [m/s]': 'wind_speed'},
@@ -80,18 +86,17 @@ MIDC_VARIABLE_MAP = {
         'Air Temperature [deg C]': 'temp_air',
         'Rel Humidity [%]': 'relative_humidity',
         'Avg Wind Speed @ 3m [m/s]': 'wind_speed'},
-    'VTIF': {
+    'NWTC': {
         'Global Horizontal [W/m^2]': 'ghi',
         'Direct Normal [W/m^2]': 'dni',
         'Diffuse Horizontal [W/m^2]': 'dhi',
-        'Air Temperature [deg C]': 'temp_air',
-        'Avg Wind Speed @ 3m [m/s]': 'wind_speed',
-        'Rel Humidity [%]': 'relative_humidity'},
-    'NWTC': {
-        'Global PSP [W/m^2]': 'ghi',
+        # PSP instrument was removed Feb. 2021
+        # PSP was mapped to ghi for pvlib<=0.10.5
+        # 'Global PSP [W/m^2]': 'ghi',
         'Temperature @ 2m [deg C]': 'temp_air',
         'Avg Wind Speed @ 2m [m/s]': 'wind_speed',
-        'Relative Humidity [%]': 'relative_humidity'}}
+        'Relative Humidity [%]': 'relative_humidity'},
+}
 
 
 # Maps problematic timezones to 'Etc/GMT' for parsing.

pvlib/iotools/psm3.py

@@ -62,8 +62,8 @@ REQUEST_VARIABLE_MAP = {
 
 
 def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60,
-             attributes=ATTRIBUTES, leap_day=None, full_name=PVLIB_PYTHON,
-             affiliation=PVLIB_PYTHON, map_variables=None, url=None,
+             attributes=ATTRIBUTES, leap_day=True, full_name=PVLIB_PYTHON,
+             affiliation=PVLIB_PYTHON, map_variables=True, url=None,
              timeout=30):
     """
     Retrieve NSRDB PSM3 timeseries weather data from the PSM3 API. The NSRDB
@@ -105,14 +105,14 @@ def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60,
         for lists of available fields. Alternatively, pvlib names may also be
         used (e.g. 'ghi' rather than 'GHI'); see :const:`REQUEST_VARIABLE_MAP`.
         To retrieve all available fields, set ``attributes=[]``.
-    leap_day : boolean, default False
+    leap_day : bool, default : True
         include leap day in the results. Only used for single-year requests
         (i.e., it is ignored for tmy/tgy/tdy requests).
     full_name : str, default 'pvlib python'
         optional
     affiliation : str, default 'pvlib python'
         optional
-    map_variables : boolean, optional
+    map_variables : bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
     url : str, optional
@@ -179,14 +179,6 @@ def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60,
     # convert pvlib names in attributes to psm3 convention
     attributes = [REQUEST_VARIABLE_MAP.get(a, a) for a in attributes]
 
-    if (leap_day is None) and (not names.startswith('t')):
-        warnings.warn(
-            'The ``get_psm3`` function will default to leap_day=True '
-            'starting in pvlib 0.11.0. Specify leap_day=True '
-            'to enable this behavior now, or specify leap_day=False '
-            'to hide this warning.', pvlibDeprecationWarning)
-        leap_day = False
-
     # required query-string parameters for request to PSM3 API
     params = {
         'api_key': api_key,
@@ -227,7 +219,7 @@ def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60,
     return parse_psm3(fbuf, map_variables)
 
 
-def parse_psm3(fbuf, map_variables=None):
+def parse_psm3(fbuf, map_variables=True):
     """
     Parse an NSRDB PSM3 weather file (formatted as SAM CSV). The NSRDB
     is described in [1]_ and the SAM CSV format is described in [2]_.
@@ -241,9 +233,9 @@ def parse_psm3(fbuf, map_variables=None):
     ----------
     fbuf: file-like object
         File-like object containing data to read.
-    map_variables: bool
+    map_variables: bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
-        where applicable. See variable VARIABLE_MAP.
+        where applicable. See variable :const:`VARIABLE_MAP`.
 
     Returns
     -------
@@ -356,13 +348,6 @@ def parse_psm3(fbuf, map_variables=None):
     tz = 'Etc/GMT%+d' % -metadata['Time Zone']
     data.index = pd.DatetimeIndex(dtidx).tz_localize(tz)
 
-    if map_variables is None:
-        warnings.warn(
-            'PSM3 variable names will be renamed to pvlib conventions by '
-            'default starting in pvlib 0.11.0. Specify map_variables=True '
-            'to enable that behavior now, or specify map_variables=False '
-            'to hide this warning.', pvlibDeprecationWarning)
-        map_variables = False
     if map_variables:
         data = data.rename(columns=VARIABLE_MAP)
         metadata['latitude'] = metadata.pop('Latitude')
@@ -372,7 +357,7 @@ def parse_psm3(fbuf, map_variables=None):
     return data, metadata
 
 
-def read_psm3(filename, map_variables=None):
+def read_psm3(filename, map_variables=True):
     """
     Read an NSRDB PSM3 weather file (formatted as SAM CSV). The NSRDB
     is described in [1]_ and the SAM CSV format is described in [2]_.
@@ -386,9 +371,9 @@ def read_psm3(filename, map_variables=None):
     ----------
     filename: str
         Filename of a file containing data to read.
-    map_variables: bool
+    map_variables: bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
-        where applicable. See variable VARIABLE_MAP.
+        where applicable. See variable :const:`VARIABLE_MAP`.
 
     Returns
     -------

pvlib/iotools/srml.py

@@ -6,8 +6,6 @@ import pandas as pd
 import urllib
 import warnings
 
-from pvlib._deprecation import deprecated
-
 # VARIABLE_MAP is a dictionary mapping SRML data element numbers to their
 # pvlib names. For most variables, only the first three digits are used,
 # the fourth indicating the instrument. Spectral data (7xxx) uses all
@@ -92,7 +90,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
 
 
@@ -172,64 +170,6 @@ def _format_index(df):
     return 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.
-
-    The SRML is described in [1]_.
-
-    Parameters
-    ----------
-    station: str
-        The name of the SRML station to request.
-    year: int
-        Year to request data for
-    month: int
-        Month to request data for.
-    filetype: string
-        SRML file type to gather. See notes for explanation.
-    map_variables: bool, default: True
-        When true, renames columns of the DataFrame to pvlib variable names
-        where applicable. See variable :const:`VARIABLE_MAP`.
-
-    Returns
-    -------
-    data: pd.DataFrame
-        One month of data from SRML.
-
-    Notes
-    -----
-    File types designate the time interval of a file and if it contains
-    raw or processed data. For instance, `RO` designates raw, one minute
-    data and `PO` designates processed one minute data. The availability
-    of file types varies between sites. Below is a table of file types
-    and their time intervals. See [1] for site information.
-
-    ============= ============ ==================
-    time interval raw filetype processed filetype
-    ============= ============ ==================
-    1 minute      RO           PO
-    5 minute      RF           PF
-    15 minute     RQ           PQ
-    hourly        RH           PH
-    ============= ============ ==================
-
-    References
-    ----------
-    .. [1] University of Oregon Solar Radiation Measurement Laboratory
-       http://solardata.uoregon.edu/
-    """
-    file_name = "{station}{filetype}{year:02d}{month:02d}.txt".format(
-        station=station,
-        filetype=filetype,
-        year=year % 100,
-        month=month)
-    url = "http://solardata.uoregon.edu/download/Archive/"
-    data = read_srml(url + file_name, map_variables=map_variables)
-    return data
-
-
 def get_srml(station, start, end, filetype='PO', map_variables=True,
              url="http://solardata.uoregon.edu/download/Archive/"):
     """Request data from UoO SRML and read it into a Dataframe.

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)