pvlib 0.13.1a1__py3-none-any.whl → 0.14.0__py3-none-any.whl

{pvlib-0.13.1a1.dist-info → pvlib-0.14.0.dist-info}/RECORD

@@ -4,26 +4,26 @@ pvlib/albedo.py,sha256=MqrkDztnF6VWaM7W28AGGEgCyAK6X13bDvPk9YEaimU,6205
 pvlib/atmosphere.py,sha256=zG6dXIrAdCvruXXHi7OthbcVqbXfSd6laib7JPkCztA,26854
 pvlib/clearsky.py,sha256=8_R4CNXkm4SoTY1ug1Vv03z6RPC3s3d5jYEXcc6KOFE,38612
 pvlib/iam.py,sha256=zL0YzOaMA2Twbl0JJ0y5nxoxjmaOb9OQGH_Z1MVGcIw,44224
-pvlib/inverter.py,sha256=P24zwKaCHZbw9ndfI2CxEhwJhcRPRGKqSUk1T7YMUdo,19406
-pvlib/irradiance.py,sha256=V6tA375iS9hcO59xaJIrqW71ct3VjF-_BdNBhNvGmYw,147720
+pvlib/inverter.py,sha256=cQw1IB965RYeb9orpBiJGaRsidAspuv1Vks3ZSwOamg,19440
+pvlib/irradiance.py,sha256=M_PqXxQ2UqIxct_81OhzF66hreh0WZuq5Ae3wS5tK2Y,147891
 pvlib/location.py,sha256=G31Iabv1KcYzMFr5sd0JhcJr9IpZx2rLv25h1K2XaAE,17509
 pvlib/modelchain.py,sha256=pwOLSlPhtxUm0d17tc2FdcD-XSItIcPkeLlUeZBw7M0,72995
-pvlib/pvarray.py,sha256=Di4wtH3U6xS-uVWjxlEFQkhD1fj76-YpSDtI4g9y6fs,14479
-pvlib/pvsystem.py,sha256=nrwLmLZ44QUxhPZCgkE53Iwe6TQLhq7aBz8cESR4SQw,112435
+pvlib/pvarray.py,sha256=rQ2lOKhC0Ons97iy0NV5iqfMoL-S0RY5yJ2byDH7WKI,19006
+pvlib/pvsystem.py,sha256=FFo1E3dpiVvHCZzOSBQXUL9mW2llyaYMtgCI0M9o3AM,116049
 pvlib/scaling.py,sha256=SsQEmM4f4O1wC7e0amEV4SgaRTBX8nG5IiSV9Xs0i5o,10983
 pvlib/shading.py,sha256=S1Av-oskqxQTyLKkmaVr854bve3StfbP_yF5isHF5zI,26172
-pvlib/singlediode.py,sha256=bzi1gb3eqfs0Svo0rzRHUd3hIL8PItPWmGVXUih4mec,35413
+pvlib/singlediode.py,sha256=7KQ0rrRg_kDYsrAgudNX40PTEbUYqTdOD-X5UHJIw2E,42569
 pvlib/snow.py,sha256=1jbfCvyi8ClE15U_stwdnxdaMnXOw8igN3BIYEjFrko,14755
 pvlib/soiling.py,sha256=zDJ3N0uyeS1CoO0mxSdG16q2FCBLZSHbujJHgish54U,8799
-pvlib/solarposition.py,sha256=qR7EEfiYJuFTEI6EW3-gqM0jArjIe9RstMrrqjU_JSE,51324
-pvlib/spa.py,sha256=rXdizMpf2WEe-eKpseN_lf5MWzFihhayrT6E6h5fkgI,44847
-pvlib/temperature.py,sha256=SE8Gsuj8uKp-CxAA_KJjMsu4m2XU6om1YJJwXHrhUrk,60725
+pvlib/solarposition.py,sha256=vcJCk8tywMJghIRrhFnkr70GzMeyaKcpPKZb3WWy7qE,51325
+pvlib/spa.py,sha256=t4WIWNnc6sTJrZigoPVs77qeK_lyxj5cHCQ-dIiOPfw,44848
+pvlib/temperature.py,sha256=KWa2Y5IV87OCbwgyti6K7GMIju9aoD0QONjW8TgmiP4,60758
 pvlib/tools.py,sha256=WX_qEGR38q3urjZdhFLqnEH2Zo7NM3RwjeWqgHbBr4I,14752
 pvlib/tracking.py,sha256=7YCuKqXdFfJl3AQVWAiAGtvWu_sV-juWwqy5N63JUSA,16303
 pvlib/transformer.py,sha256=FXyYaPPooFXAvAP3Ib5vENDVJocbo6kUuBAPzQdimHo,3437
 pvlib/version.py,sha256=0CONzyOSN34Jgbaj9JzemFuaEnbRON_yxp-ah6_KxxQ,165
 pvlib/bifacial/__init__.py,sha256=64cyMvdne1gJJ-tSEetheorxEeMm-TOIad1u-0DSucA,460
-pvlib/bifacial/infinite_sheds.py,sha256=n5RN3vHpUge67-jp0ChwBxgd8ydKLS77MFuFzdMhqTk,22970
+pvlib/bifacial/infinite_sheds.py,sha256=B83Tv1QOiSp64N3L5XMFFN6V8y1NmN7-9IJQzzO6K6Q,22992
 pvlib/bifacial/loss_models.py,sha256=RDl9TcKqFoYXnE3P88DjLVFODh2mHdKEFUUH-BnvH7E,5944
 pvlib/bifacial/pvfactors.py,sha256=6o1xh5Lihl5AO8qrMWCYUxVJCJe4-WrFzYZwzq_8n0I,5438
 pvlib/bifacial/utils.py,sha256=98D7buxlcE8oilC3BqHqqDT7pCjrM-dAGhYvpYjqalU,14558
@@ -38,17 +38,18 @@ pvlib/data/sam-library-cec-inverters-2019-03-05.csv,sha256=wZIlLw1hIE31j7DflVFKK
 pvlib/data/sam-library-cec-modules-2019-03-05.csv,sha256=p8OxrT2rtUJTaGFcFjIvLjUYX8QWOAtHHE5I3VRbGSA,5446588
 pvlib/data/sam-library-sandia-modules-2015-6-30.csv,sha256=fhC-Oi0IaYVViKEjyDyDWDCIFfD52rU2gL7w2FBAhPM,195253
 pvlib/data/soiling_hsu_example_inputs.csv,sha256=Dkr0Sc5GA2s6I2hBSeAGIEI5J4KKBNgf-LTtzKS0qEE,319716
-pvlib/iotools/__init__.py,sha256=QeZOMwEfflXTh7VZcDybKBUyNSfUHLLLHIk3-f3v85g,3035
-pvlib/iotools/acis.py,sha256=nzuH3SZBhMNoSk0fBr35O4YADDah6D02Acyj5RNUYeI,18449
+pvlib/iotools/__init__.py,sha256=AQ3w7rO6qOq__BEtAZ8O7x8JcwXmuMlXTH9U2a7KDNY,2982
+pvlib/iotools/acis.py,sha256=PvD7pjA3n5fX6WIwgVO4o0nseVS5rPFdzbhnEukqFU4,18455
 pvlib/iotools/bsrn.py,sha256=N1bkRukFfHzV95jjEZIKRDdxizddV7cXQUKo--bElw8,22013
 pvlib/iotools/crn.py,sha256=PLugc4RF_0LzesWHnyCOtx9KmqeECZH9kxcXgzgjGrQ,5336
 pvlib/iotools/epw.py,sha256=Y9R9Od3AQqyHMxCRAUuOzFpZkzaAUXeERAZ44RyQjXU,17470
+pvlib/iotools/era5.py,sha256=3Eq-fsxONklT_nXGVMuiCzfCZxRNLJqdiZFFYqT9m9I,6490
+pvlib/iotools/merra2.py,sha256=-P_eCYFfeOae3oSC4s6LdxK35QPyVhfnhZ5lusP-anU,7587
 pvlib/iotools/meteonorm.py,sha256=wFwURSSnde9SxgBzdV_SluL6YsXb2l6hrnf0e9dl1sY,22534
 pvlib/iotools/midc.py,sha256=T2kskGsBzeHY-9HHc8096mbOaifKvFturCTcZq1pIzY,9568
 pvlib/iotools/nasa_power.py,sha256=HhRYycK2q6hD1BSU0-P06loqhkuBoqaQdqNhYQQkYBM,5188
 pvlib/iotools/panond.py,sha256=okK6zNh5r-H1gDPbZRmWEcYYaBmifPhp1ESR-P2YM9s,5262
-pvlib/iotools/psm3.py,sha256=MO0l-YPvgAcXqaRFh9u79e1aMl8CU9OFvtjc_h957-Y,13661
-pvlib/iotools/psm4.py,sha256=TVU_uZmShnJdsCL7DABnluvYENshpIcYJbJCg864rRw,30112
+pvlib/iotools/psm4.py,sha256=W_tOdgbLR1Tchd_lxOfPazqRauBWJ2ywHaaJl2xKeF4,30084
 pvlib/iotools/pvgis.py,sha256=dd5mfODwYEVaNv-UvNjbvBbQgKUi5C89rna_h8KWphM,32279
 pvlib/iotools/sodapro.py,sha256=3oBnN3GhDrB1tHmjgpSiYehitv7POFhs1yBzGDNOxOQ,15234
 pvlib/iotools/solaranywhere.py,sha256=_kDetQ0R8rQgcfTZjeQArq9nmCtVa4upF_KGrcipovQ,12535
@@ -61,22 +62,22 @@ pvlib/iotools/tmy.py,sha256=k96b43OXuiezq3UwCVBMnWlmPsbUf8ry5HvZ9LpaX6Q,26694
 pvlib/ivtools/__init__.py,sha256=bnUDPqkzCP96CaFFK3Gw4HNczJoHtO-cI9GBGAtZVGI,159
 pvlib/ivtools/sde.py,sha256=HL2oE70Ls7xccikyaUSi6SQKx3cWES5XoaMAGuMjPIw,17008
 pvlib/ivtools/utils.py,sha256=xL88J-RuYLXFZyy1za8tvoWei0hcwWb_2ktXara2m_M,19423
-pvlib/ivtools/sdm/__init__.py,sha256=P9akg2O7mFkAXoC8Kh2HcaZhbT96K4tTKnYr3b1dt2g,474
+pvlib/ivtools/sdm/__init__.py,sha256=_Nn-Wwc0h10yHHb8UdSykWIZwBYsj3aA8-S6nuRmm1Y,500
 pvlib/ivtools/sdm/_fit_desoto_pvsyst_sandia.py,sha256=E3A-Q3qSdrbMGkibx_9YHevNG9ivWkSI4mp3dElB7vU,22522
 pvlib/ivtools/sdm/cec.py,sha256=_YZjurrd-HZfm3Ild9PewXJ54fRFD1O4lZ0nt67IMtA,3437
-pvlib/ivtools/sdm/desoto.py,sha256=rGOVFoOc5YoIqPPrhCYl3M2lKRbWTsromnb43C6uyzc,15111
+pvlib/ivtools/sdm/desoto.py,sha256=bmwrVEAM0PQpAuWJCHeasI8aRQGGYMcUvHoCuRZSKaU,17313
 pvlib/ivtools/sdm/pvsyst.py,sha256=vn87iYgMcHX9Lx5SfXvRpaF0F5VUzCbWijN7f74STxA,23260
 pvlib/spa_c_files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pvlib/spa_c_files/setup.py,sha256=RcMEf0R2wKHJjvpUH5y6h22m86y6UrdXwkPkHKNme48,1102
 pvlib/spa_c_files/spa_py_example.py,sha256=p3ms0mhLycAuZJyaE3Wageqnd_56zh2EKxXK-jlTJfg,1179
-pvlib/spectrum/__init__.py,sha256=8lK8ZJRh5nl4A6eK0OlbiHdViorCHiJkANrK7QkjQIw,516
+pvlib/spectrum/__init__.py,sha256=vIceJAPkSAXRmpT53VRBwd5-rqaVa1Tws3I1JOaWMOY,542
 pvlib/spectrum/irradiance.py,sha256=VY0-FTUv2WWHTZRyy4lo8lQGrAjIREf4nQMVYrv0mXM,7827
-pvlib/spectrum/mismatch.py,sha256=hVvMeBC2YYvFuq0rVYI9dZ2Mt51SlQjTZywx9t8C2e8,29904
+pvlib/spectrum/mismatch.py,sha256=Ucb7hTUB8gD1fY0AC9K2XSifsK7jhze-hghNAJ7DJVA,34291
 pvlib/spectrum/response.py,sha256=k3FCoPPR_2yGrfXPGsZljJcgrQ7sckQn0CwiqERNntY,9413
 pvlib/spectrum/spectrl2.py,sha256=sPOZe5lXgkwMem3JbEi19uW7OQq4FzxcZyCnxzXFjWs,19022
-pvlib-0.13.1a1.dist-info/licenses/AUTHORS.md,sha256=Fxk4p_lXlMeQ6g2A1-7oPrgpULDxuJuC9Ebc-3yyj_o,1474
-pvlib-0.13.1a1.dist-info/licenses/LICENSE,sha256=oC4S3araPPDV292K_91XfC7sZAdYqVhCowT3UTuMC-Q,1622
-pvlib-0.13.1a1.dist-info/METADATA,sha256=6DJEZpYV3jKIcxwje0iH97KVik2LIkM9ORTEr2UIbtM,2900
-pvlib-0.13.1a1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pvlib-0.13.1a1.dist-info/top_level.txt,sha256=eq9CH6YXUc3Fh3dyQ5hQXoGYfSm1SYEAlMygyR22MgE,6
-pvlib-0.13.1a1.dist-info/RECORD,,
+pvlib-0.14.0.dist-info/licenses/AUTHORS.md,sha256=Fxk4p_lXlMeQ6g2A1-7oPrgpULDxuJuC9Ebc-3yyj_o,1474
+pvlib-0.14.0.dist-info/licenses/LICENSE,sha256=oC4S3araPPDV292K_91XfC7sZAdYqVhCowT3UTuMC-Q,1622
+pvlib-0.14.0.dist-info/METADATA,sha256=PV0R-xC119QvE935W-OcQFGw_7j15fptn50Gesfhlz0,2912
+pvlib-0.14.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pvlib-0.14.0.dist-info/top_level.txt,sha256=eq9CH6YXUc3Fh3dyQ5hQXoGYfSm1SYEAlMygyR22MgE,6
+pvlib-0.14.0.dist-info/RECORD,,

pvlib/iotools/psm3.py

@@ -1,365 +0,0 @@
-"""
-Get PSM3 TMY
-see https://developer.nrel.gov/docs/solar/nsrdb/psm3_data_download/
-"""
-
-import io
-import requests
-import pandas as pd
-from json import JSONDecodeError
-from pvlib._deprecation import deprecated
-from pvlib import tools
-
-NSRDB_API_BASE = "https://developer.nrel.gov"
-PSM_URL = NSRDB_API_BASE + "/api/nsrdb/v2/solar/psm3-2-2-download.csv"
-TMY_URL = NSRDB_API_BASE + "/api/nsrdb/v2/solar/psm3-tmy-download.csv"
-PSM5MIN_URL = NSRDB_API_BASE + "/api/nsrdb/v2/solar/psm3-5min-download.csv"
-
-ATTRIBUTES = (
-    'air_temperature', 'dew_point', 'dhi', 'dni', 'ghi', 'surface_albedo',
-    'surface_pressure', 'wind_direction', 'wind_speed')
-PVLIB_PYTHON = 'pvlib python'
-
-# Dictionary mapping PSM3 response names to pvlib names
-VARIABLE_MAP = {
-    'GHI': 'ghi',
-    'DHI': 'dhi',
-    'DNI': 'dni',
-    'Clearsky GHI': 'ghi_clear',
-    'Clearsky DHI': 'dhi_clear',
-    'Clearsky DNI': 'dni_clear',
-    'Solar Zenith Angle': 'solar_zenith',
-    'Temperature': 'temp_air',
-    'Dew Point': 'temp_dew',
-    'Relative Humidity': 'relative_humidity',
-    'Pressure': 'pressure',
-    'Wind Speed': 'wind_speed',
-    'Wind Direction': 'wind_direction',
-    'Surface Albedo': 'albedo',
-    'Precipitable Water': 'precipitable_water',
-}
-
-# Dictionary mapping pvlib names to PSM3 request names
-# Note, PSM3 uses different names for the same variables in the
-# response and the request
-REQUEST_VARIABLE_MAP = {
-    'ghi': 'ghi',
-    'dhi': 'dhi',
-    'dni': 'dni',
-    'ghi_clear': 'clearsky_ghi',
-    'dhi_clear': 'clearsky_dhi',
-    'dni_clear': 'clearsky_dni',
-    'solar_zenith': 'solar_zenith_angle',
-    'temp_air': 'air_temperature',
-    'temp_dew': 'dew_point',
-    'relative_humidity': 'relative_humidity',
-    'pressure': 'surface_pressure',
-    'wind_speed': 'wind_speed',
-    'wind_direction': 'wind_direction',
-    'albedo': 'surface_albedo',
-    'precipitable_water': 'total_precipitable_water',
-}
-
-
-def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60,
-             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
-    is described in [1]_ and the PSM3 API is described in [2]_, [3]_, and [4]_.
-
-    .. versionchanged:: 0.9.0
-       The function now returns a tuple where the first element is a dataframe
-       and the second element is a dictionary containing metadata. Previous
-       versions of this function had the return values switched.
-
-    .. versionchanged:: 0.10.0
-       The default endpoint for hourly single-year datasets is now v3.2.2.
-       The previous datasets can still be accessed (for now) by setting
-       the ``url`` parameter to the original API endpoint
-       (``"https://developer.nrel.gov/api/nsrdb/v2/solar/psm3-download.csv"``).
-
-    Parameters
-    ----------
-    latitude : float or int
-        in decimal degrees, between -90 and 90, north is positive
-    longitude : float or int
-        in decimal degrees, between -180 and 180, east is positive
-    api_key : str
-        NREL Developer Network API key
-    email : str
-        NREL API uses this to automatically communicate messages back
-        to the user only if necessary
-    names : str, default 'tmy'
-        PSM3 API parameter specifing year (e.g. ``2020``) or TMY variant
-        to download (e.g. ``'tmy'`` or ``'tgy-2019'``).  The allowed values
-        update periodically, so consult the NSRDB references below for the
-        current set of options.
-    interval : int, {60, 5, 15, 30}
-        interval size in minutes, must be 5, 15, 30 or 60. Must be 60 for
-        typical year requests (i.e., tmy/tgy/tdy).
-    attributes : list of str, optional
-        meteorological fields to fetch. If not specified, defaults to
-        ``pvlib.iotools.psm3.ATTRIBUTES``. See references [2]_, [3]_, and [4]_
-        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 : 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 : bool, default True
-        When true, renames columns of the Dataframe to pvlib variable names
-        where applicable. See variable :const:`VARIABLE_MAP`.
-    url : str, optional
-        API endpoint URL.  If not specified, the endpoint is determined from
-        the ``names`` and ``interval`` parameters.
-    timeout : int, default 30
-        time in seconds to wait for server response before timeout
-
-    Returns
-    -------
-    data : pandas.DataFrame
-        timeseries data from NREL PSM3
-    metadata : dict
-        metadata from NREL PSM3 about the record, see
-        :func:`pvlib.iotools.read_psm3` for fields
-
-    Raises
-    ------
-    requests.HTTPError
-        if the request response status is not ok, then the ``'errors'`` field
-        from the JSON response or any error message in the content will be
-        raised as an exception, for example if the `api_key` was rejected or if
-        the coordinates were not found in the NSRDB
-
-    Notes
-    -----
-    The required NREL developer key, `api_key`, is available for free by
-    registering at the `NREL Developer Network <https://developer.nrel.gov/>`_.
-
-    .. warning:: The "DEMO_KEY" `api_key` is severely rate limited and may
-        result in rejected requests.
-
-    .. warning:: PSM3 is limited to data found in the NSRDB, please consult the
-        references below for locations with available data. Additionally,
-        querying data with < 30-minute resolution uses a different API endpoint
-        with fewer available fields (see [4]_).
-
-    See Also
-    --------
-    pvlib.iotools.read_psm3
-
-    References
-    ----------
-
-    .. [1] `NREL National Solar Radiation Database (NSRDB)
-       <https://nsrdb.nrel.gov/>`_
-    .. [2] `Physical Solar Model (PSM) v3.2.2
-       <https://developer.nrel.gov/docs/solar/nsrdb/psm3-2-2-download/>`_
-    .. [3] `Physical Solar Model (PSM) v3 TMY
-       <https://developer.nrel.gov/docs/solar/nsrdb/psm3-tmy-download/>`_
-    .. [4] `Physical Solar Model (PSM) v3 - Five Minute Temporal Resolution
-       <https://developer.nrel.gov/docs/solar/nsrdb/psm3-5min-download/>`_
-    """
-    # The well know text (WKT) representation of geometry notation is strict.
-    # A POINT object is a string with longitude first, then the latitude, with
-    # four decimals each, and exactly one space between them.
-    longitude = ('%9.4f' % longitude).strip()
-    latitude = ('%8.4f' % latitude).strip()
-    # TODO: make format_WKT(object_type, *args) in tools.py
-
-    # convert to string to accomodate integer years being passed in
-    names = str(names)
-
-    # convert pvlib names in attributes to psm3 convention
-    attributes = [REQUEST_VARIABLE_MAP.get(a, a) for a in attributes]
-
-    # required query-string parameters for request to PSM3 API
-    params = {
-        'api_key': api_key,
-        'full_name': full_name,
-        'email': email,
-        'affiliation': affiliation,
-        'reason': PVLIB_PYTHON,
-        'mailing_list': 'false',
-        'wkt': 'POINT(%s %s)' % (longitude, latitude),
-        'names': names,
-        'attributes':  ','.join(attributes),
-        'leap_day': str(leap_day).lower(),
-        'utc': 'false',
-        'interval': interval
-    }
-    # request CSV download from NREL PSM3
-    if url is None:
-        # determine the endpoint that suits the user inputs
-        if any(prefix in names for prefix in ('tmy', 'tgy', 'tdy')):
-            url = TMY_URL
-        elif interval in (5, 15):
-            url = PSM5MIN_URL
-        else:
-            url = PSM_URL
-
-    response = requests.get(url, params=params, timeout=timeout)
-    if not response.ok:
-        # if the API key is rejected, then the response status will be 403
-        # Forbidden, and then the error is in the content and there is no JSON
-        try:
-            errors = response.json()['errors']
-        except JSONDecodeError:
-            errors = response.content.decode('utf-8')
-        raise requests.HTTPError(errors, response=response)
-    # the CSV is in the response content as a UTF-8 bytestring
-    # to use pandas we need to create a file buffer from the response
-    fbuf = io.StringIO(response.content.decode('utf-8'))
-    return read_psm3(fbuf, map_variables)
-
-
-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]_.
-
-    .. versionchanged:: 0.9.0
-       The function now returns a tuple where the first element is a dataframe
-       and the second element is a dictionary containing metadata. Previous
-       versions of this function had the return values switched.
-
-    Parameters
-    ----------
-    filename: str, path-like, or buffer
-        Filename or in-memory buffer of a file containing data to read.
-    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 : pandas.DataFrame
-        timeseries data from NREL PSM3
-    metadata : dict
-        metadata from NREL PSM3 about the record, see notes for fields
-
-    Notes
-    -----
-    The return is a tuple with two items. The first item is a dataframe with
-    the PSM3 timeseries data.
-
-    The second item is a dictionary with metadata from NREL PSM3 about the
-    record containing the following fields:
-
-    * Source
-    * Location ID
-    * City
-    * State
-    * Country
-    * Latitude
-    * Longitude
-    * Time Zone
-    * Elevation
-    * Local Time Zone
-    * Clearsky DHI Units
-    * Clearsky DNI Units
-    * Clearsky GHI Units
-    * Dew Point Units
-    * DHI Units
-    * DNI Units
-    * GHI Units
-    * Solar Zenith Angle Units
-    * Temperature Units
-    * Pressure Units
-    * Relative Humidity Units
-    * Precipitable Water Units
-    * Wind Direction Units
-    * Wind Speed Units
-    * Cloud Type -15
-    * Cloud Type 0
-    * Cloud Type 1
-    * Cloud Type 2
-    * Cloud Type 3
-    * Cloud Type 4
-    * Cloud Type 5
-    * Cloud Type 6
-    * Cloud Type 7
-    * Cloud Type 8
-    * Cloud Type 9
-    * Cloud Type 10
-    * Cloud Type 11
-    * Cloud Type 12
-    * Fill Flag 0
-    * Fill Flag 1
-    * Fill Flag 2
-    * Fill Flag 3
-    * Fill Flag 4
-    * Fill Flag 5
-    * Surface Albedo Units
-    * Version
-
-    Examples
-    --------
-    >>> # Read a local PSM3 file:
-    >>> df, metadata = iotools.read_psm3("data.csv")  # doctest: +SKIP
-
-    >>> # Read a file object or an in-memory buffer:
-    >>> with open(filename, 'r') as f:  # doctest: +SKIP
-    ...     df, metadata = iotools.read_psm3(f)  # doctest: +SKIP
-
-    See Also
-    --------
-    pvlib.iotools.get_psm3
-
-    References
-    ----------
-    .. [1] `NREL National Solar Radiation Database (NSRDB)
-       <https://nsrdb.nrel.gov/>`_
-    .. [2] `Standard Time Series Data File Format
-       <https://web.archive.org/web/20170207203107/https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf>`_
-    """
-    with tools._file_context_manager(filename) as fbuf:
-        # The first 2 lines of the response are headers with metadata
-        metadata_fields = fbuf.readline().split(',')
-        metadata_values = fbuf.readline().split(',')
-        # get the column names so we can set the dtypes
-        columns = fbuf.readline().split(',')
-        columns[-1] = columns[-1].strip()  # strip trailing newline
-        # Since the header has so many columns, excel saves blank cols in the
-        # data below the header lines.
-        columns = [col for col in columns if col != '']
-        dtypes = dict.fromkeys(columns, float)  # all floats except datevec
-        dtypes.update({'Year': int, 'Month': int, 'Day': int, 'Hour': int,
-                       'Minute': int, 'Cloud Type': int, 'Fill Flag': int})
-        data = pd.read_csv(
-            fbuf, header=None, names=columns, usecols=columns, dtype=dtypes,
-            delimiter=',', lineterminator='\n')  # skip carriage returns \r
-
-    metadata_fields[-1] = metadata_fields[-1].strip()  # trailing newline
-    metadata_values[-1] = metadata_values[-1].strip()  # trailing newline
-    metadata = dict(zip(metadata_fields, metadata_values))
-    # the response is all strings, so set some metadata types to numbers
-    metadata['Local Time Zone'] = int(metadata['Local Time Zone'])
-    metadata['Time Zone'] = int(metadata['Time Zone'])
-    metadata['Latitude'] = float(metadata['Latitude'])
-    metadata['Longitude'] = float(metadata['Longitude'])
-    metadata['Elevation'] = int(metadata['Elevation'])
-
-    # the response 1st 5 columns are a date vector, convert to datetime
-    dtidx = pd.to_datetime(data[['Year', 'Month', 'Day', 'Hour', 'Minute']])
-    # in USA all timezones are integers
-    tz = 'Etc/GMT%+d' % -metadata['Time Zone']
-    data.index = pd.DatetimeIndex(dtidx).tz_localize(tz)
-
-    if map_variables:
-        data = data.rename(columns=VARIABLE_MAP)
-        metadata['latitude'] = metadata.pop('Latitude')
-        metadata['longitude'] = metadata.pop('Longitude')
-        metadata['altitude'] = metadata.pop('Elevation')
-
-    return data, metadata
-
-
-parse_psm3 = deprecated(since="0.13.0", name="parse_psm3",
-                        alternative="read_psm3")(read_psm3)