change "goes4" to "psm4"

Author: williamhobbs

pvlib/data/test_goes4_2023.csv pvlib/data/test_psm4_2023.csvpvlib/data/test_goes4_2023.csv renamed to pvlib/data/test_psm4_2023.csv

@@ -1,5 +1,5 @@
 """
-Get NSRDB GOES V4.0.0
+Get NSRDB PSM4
 see
 https://developer.nrel.gov/docs/solar/nsrdb/nsrdb-GOES-conus-v4-0-0-download/
 """
@@ -23,7 +23,7 @@
     'surface_pressure', 'wind_direction', 'wind_speed')
 PVLIB_PYTHON = 'pvlib python'
 
-# Dictionary mapping GOES4 response names to pvlib names
+# Dictionary mapping PSM4 response names to pvlib names
 VARIABLE_MAP = {
     'GHI': 'ghi',
     'DHI': 'dhi',
@@ -45,8 +45,8 @@
     'Asymmetry': 'asymmetry',
 }
 
-# Dictionary mapping pvlib names to GOES4 request names
-# Note, GOES4 uses different names for the same variables in the
+# Dictionary mapping pvlib names to PSM4 request names
+# Note, PSM4 uses different names for the same variables in the
 # response and the request
 REQUEST_VARIABLE_MAP = {
     'ghi': 'ghi',
@@ -70,12 +70,12 @@
 }
 
 
-def get_goes4(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):
+def get_psm4(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 GOES4 timeseries weather data from the GOES4 API. The NSRDB
+    Retrieve NSRDB PSM4 timeseries weather data from the GOES4 API. The NSRDB
     is described in [1]_ and the GOES4 API is described in [2]_, [3]_, and
     [4]_.
 
@@ -100,7 +100,7 @@ def get_goes4(latitude, longitude, api_key, email, names='tmy', interval=60,
         typical year requests (i.e., tmy/tgy/tdy).
     attributes : list of str, optional
         meteorological fields to fetch. If not specified, defaults to
-        ``pvlib.iotools.goes4.ATTRIBUTES``. See references [2]_, [3]_, and [4]_
+        ``pvlib.iotools.psm4.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=[]``.
@@ -123,10 +123,10 @@ def get_goes4(latitude, longitude, api_key, email, names='tmy', interval=60,
     Returns
     -------
     data : pandas.DataFrame
-        timeseries data from NREL GOES4
+        timeseries data from NREL PSM4
     metadata : dict
-        metadata from NREL GOES4 about the record, see
-        :func:`pvlib.iotools.parse_goes4` for fields
+        metadata from NREL PSM4 about the record, see
+        :func:`pvlib.iotools.parse_psm4` for fields
 
     Raises
     ------
@@ -144,14 +144,14 @@ def get_goes4(latitude, longitude, api_key, email, names='tmy', interval=60,
     .. warning:: The "DEMO_KEY" `api_key` is severely rate limited and may
         result in rejected requests.
 
-    .. warning:: GOES4 is limited to data found in the NSRDB, please consult
+    .. warning:: PSM4 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_goes4, pvlib.iotools.parse_goes4
+    pvlib.iotools.read_psm4, pvlib.iotools.parse_psm4
 
     References
     ----------
@@ -175,7 +175,7 @@ def get_goes4(latitude, longitude, api_key, email, names='tmy', interval=60,
     # convert to string to accomodate integer years being passed in
     names = str(names)
 
-    # convert pvlib names in attributes to psm3/goes4 convention
+    # convert pvlib names in attributes to PSM4 convention
     attributes = [REQUEST_VARIABLE_MAP.get(a, a) for a in attributes]
 
     # required query-string parameters for request to GOES4 API
@@ -193,7 +193,7 @@ def get_goes4(latitude, longitude, api_key, email, names='tmy', interval=60,
         'utc': 'false',
         'interval': interval
     }
-    # request CSV download from NREL GOES4
+    # request CSV download from NREL PSM4
     if url is None:
         # determine the endpoint that suits the user inputs
         if any(prefix in names for prefix in ('tmy', 'tgy', 'tdy')):
@@ -220,7 +220,7 @@ def get_goes4(latitude, longitude, api_key, email, names='tmy', interval=60,
 
 def parse_goes4(fbuf, map_variables=True):
     """
-    Parse an NSRDB GOES4 weather file (formatted as SAM CSV). The NSRDB
+    Parse an NSRDB PSM4 weather file (formatted as SAM CSV). The NSRDB
     is described in [1]_ and the SAM CSV format is described in [2]_.
 
     Parameters
@@ -234,16 +234,16 @@ def parse_goes4(fbuf, map_variables=True):
     Returns
     -------
     data : pandas.DataFrame
-        timeseries data from NREL GOES4
+        timeseries data from NREL PSM4
     metadata : dict
-        metadata from NREL GOES4 about the record, see notes for fields
+        metadata from NREL PSM4 about the record, see notes for fields
 
     Notes
     -----
     The return is a tuple with two items. The first item is a dataframe with
-    the GOES4 timeseries data.
+    the PSM4 timeseries data.
 
-    The second item is a dictionary with metadata from NREL GOES4 about the
+    The second item is a dictionary with metadata from NREL PSM4 about the
     record containing the following fields:
 
     * Source
@@ -295,13 +295,13 @@ def parse_goes4(fbuf, map_variables=True):
 
     Examples
     --------
-    >>> # Read a local GOES4 file:
+    >>> # Read a local PSM4 file:
     >>> with open(filename, 'r') as f:  # doctest: +SKIP
-    ...     df, metadata = iotools.parse_goes4(f)  # doctest: +SKIP
+    ...     df, metadata = iotools.parse_psm4(f)  # doctest: +SKIP
 
     See Also
     --------
-    pvlib.iotools.read_goes4, pvlib.iotools.get_goes4
+    pvlib.iotools.read_psm4, pvlib.iotools.get_psm4
 
     References
     ----------
@@ -351,9 +351,9 @@ def parse_goes4(fbuf, map_variables=True):
     return data, metadata
 
 
-def read_goes4(filename, map_variables=True):
+def read_psm4(filename, map_variables=True):
     """
-    Read an NSRDB GOES4 weather file (formatted as SAM CSV). The NSRDB
+    Read an NSRDB PSM4 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
@@ -372,14 +372,14 @@ def read_goes4(filename, map_variables=True):
     Returns
     -------
     data : pandas.DataFrame
-        timeseries data from NREL GOES4
+        timeseries data from NREL PSM4
     metadata : dict
-        metadata from NREL GOES4 about the record, see
-        :func:`pvlib.iotools.parse_goes4` for fields
+        metadata from NREL PSM4 about the record, see
+        :func:`pvlib.iotools.parse_psm4` for fields
 
     See Also
     --------
-    pvlib.iotools.parse_goes4, pvlib.iotools.get_goes4
+    pvlib.iotools.parse_psm4, pvlib.iotools.get_psm4
 
     References
     ----------
@@ -389,5 +389,5 @@ def read_goes4(filename, map_variables=True):
        <https://web.archive.org/web/20170207203107/https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf>`_
     """
     with open(str(filename), 'r') as fbuf:
-        content = parse_goes4(fbuf, map_variables)
+        content = parse_psm4(fbuf, map_variables)
     return content

pvlib/data/test_goes4_2023_5min.csv pvlib/data/test_psm4_2023_5min.csvpvlib/data/test_goes4_2023_5min.csv renamed to pvlib/data/test_psm4_2023_5min.csv

@@ -1,9 +1,9 @@
 """
-test iotools for GOES4
+test iotools for PSM4
 """
 
 import os
-from pvlib.iotools import goes4
+from pvlib.iotools import psm4
 from ..conftest import DATA_DIR, RERUNS, RERUNS_DELAY, assert_index_equal
 import numpy as np
 import pandas as pd
@@ -12,10 +12,10 @@
 from io import StringIO
 import warnings
 
-TMY_TEST_DATA = DATA_DIR / 'test_goes4_tmy-2023.csv'
-YEAR_TEST_DATA = DATA_DIR / 'test_goes4_2023.csv'
-YEAR_TEST_DATA_5MIN = DATA_DIR / 'test_goes4_2023_5min.csv'
-MANUAL_TEST_DATA = DATA_DIR / 'test_read_goes4.csv'
+TMY_TEST_DATA = DATA_DIR / 'test_psm4_tmy-2023.csv'
+YEAR_TEST_DATA = DATA_DIR / 'test_psm4_2023.csv'
+YEAR_TEST_DATA_5MIN = DATA_DIR / 'test_psm4_2023_5min.csv'
+MANUAL_TEST_DATA = DATA_DIR / 'test_read_psm4.csv'
 LATITUDE, LONGITUDE = 40.5137, -108.5449
 METADATA_FIELDS = [
     'Source', 'Location ID', 'City', 'State', 'Country', 'Latitude',
@@ -46,8 +46,8 @@ def nrel_api_key():
     return demo_key
 
 
-def assert_goes4_equal(data, metadata, expected):
-    """check consistency of GOES4 data"""
+def assert_psm4_equal(data, metadata, expected):
+    """check consistency of PSM4 data"""
     # check datevec columns
     assert np.allclose(data.Year, expected.Year)
     assert np.allclose(data.Month, expected.Month)
@@ -73,46 +73,46 @@ def assert_goes4_equal(data, metadata, expected):
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_goes4_tmy(nrel_api_key):
-    """test get_goes4 with a TMY"""
-    data, metadata = goes4.get_goes4(LATITUDE, LONGITUDE, nrel_api_key,
-                                     PVLIB_EMAIL, names='tmy-2023',
-                                     leap_day=False, map_variables=False)
+def test_get_psm4_tmy(nrel_api_key):
+    """test get_psm4 with a TMY"""
+    data, metadata = psm4.get_psm4(LATITUDE, LONGITUDE, nrel_api_key,
+                                   PVLIB_EMAIL, names='tmy-2023',
+                                   leap_day=False, map_variables=False)
     expected = pd.read_csv(TMY_TEST_DATA)
-    assert_goes4_equal(data, metadata, expected)
+    assert_psm4_equal(data, metadata, expected)
 
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_goes4_singleyear(nrel_api_key):
-    """test get_goes4 with a single year"""
-    data, metadata = goes4.get_goes4(LATITUDE, LONGITUDE, nrel_api_key,
-                                     PVLIB_EMAIL, names='2023',
-                                     leap_day=False,  map_variables=False,
-                                     interval=30)
+def test_get_psm4_singleyear(nrel_api_key):
+    """test get_psm4 with a single year"""
+    data, metadata = psm4.get_psm4(LATITUDE, LONGITUDE, nrel_api_key,
+                                   PVLIB_EMAIL, names='2023',
+                                   leap_day=False,  map_variables=False,
+                                   interval=30)
     expected = pd.read_csv(YEAR_TEST_DATA)
-    assert_goes4_equal(data, metadata, expected)
+    assert_psm4_equal(data, metadata, expected)
 
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_goes4_5min(nrel_api_key):
-    """test get_goes4 for 5-minute data"""
-    data, metadata = goes4.get_goes4(LATITUDE, LONGITUDE, nrel_api_key,
-                                     PVLIB_EMAIL, names='2023', interval=5,
-                                     leap_day=False, map_variables=False)
+def test_get_psm4_5min(nrel_api_key):
+    """test get_psm4 for 5-minute data"""
+    data, metadata = psm4.get_psm4(LATITUDE, LONGITUDE, nrel_api_key,
+                                   PVLIB_EMAIL, names='2023', interval=5,
+                                   leap_day=False, map_variables=False)
     assert len(data) == 525600/5
     first_day = data.loc['2023-01-01']
     expected = pd.read_csv(YEAR_TEST_DATA_5MIN)
-    assert_goes4_equal(first_day, metadata, expected)
+    assert_psm4_equal(first_day, metadata, expected)
 
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_goes4_check_leap_day(nrel_api_key):
-    data_2012, _ = goes4.get_goes4(LATITUDE, LONGITUDE, nrel_api_key,
-                                   PVLIB_EMAIL, names="2012", interval=60,
-                                   leap_day=True, map_variables=False)
+def test_get_psm4_check_leap_day(nrel_api_key):
+    data_2012, _ = psm4.get_psm4(LATITUDE, LONGITUDE, nrel_api_key,
+                                 PVLIB_EMAIL, names="2012", interval=60,
+                                 leap_day=True, map_variables=False)
     assert len(data_2012) == (8760 + 24)
 
 
@@ -124,10 +124,10 @@ def test_get_goes4_check_leap_day(nrel_api_key):
                           ])
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_goes4_tmy_errors(
+def test_get_psm4_tmy_errors(
     latitude, longitude, api_key, names, interval
 ):
-    """Test get_goes4() for multiple erroneous input scenarios.
+    """Test get_psm4() for multiple erroneous input scenarios.
 
     These scenarios include:
     * Bad API key -> HTTP 403 forbidden because api_key is rejected
@@ -136,39 +136,39 @@ def test_get_goes4_tmy_errors(
     * Bad interval, single year -> Intervals can only be 30 or 60 minutes.
     """
     with pytest.raises(HTTPError) as excinfo:
-        goes4.get_goes4(latitude, longitude, api_key, PVLIB_EMAIL,
-                        names=names, interval=interval, leap_day=False,
-                        map_variables=False)
+        psm4.get_psm4(latitude, longitude, api_key, PVLIB_EMAIL,
+                      names=names, interval=interval, leap_day=False,
+                      map_variables=False)
     # ensure the HTTPError caught isn't due to overuse of the API key
     assert "OVER_RATE_LIMIT" not in str(excinfo.value)
 
 
 @pytest.fixture
 def io_input(request):
-    """file-like object for parse_goes4"""
+    """file-like object for parse_psm4"""
     with MANUAL_TEST_DATA.open() as f:
         data = f.read()
     obj = StringIO(data)
     return obj
 
 
-def test_parse_goes4(io_input):
-    """test parse_goes4"""
-    data, metadata = goes4.parse_goes4(io_input, map_variables=False)
+def test_parse_psm4(io_input):
+    """test parse_psm4"""
+    data, metadata = psm4.parse_psm4(io_input, map_variables=False)
     expected = pd.read_csv(YEAR_TEST_DATA)
-    assert_goes4_equal(data, metadata, expected)
+    assert_psm4_equal(data, metadata, expected)
 
 
-def test_read_goes4():
-    """test read_goes4"""
-    data, metadata = goes4.read_goes4(MANUAL_TEST_DATA, map_variables=False)
+def test_read_psm4():
+    """test read_psm4"""
+    data, metadata = psm4.read_psm4(MANUAL_TEST_DATA, map_variables=False)
     expected = pd.read_csv(YEAR_TEST_DATA)
-    assert_goes4_equal(data, metadata, expected)
+    assert_psm4_equal(data, metadata, expected)
 
 
-def test_read_goes4_map_variables():
-    """test read_goes4 map_variables=True"""
-    data, metadata = goes4.read_goes4(MANUAL_TEST_DATA, map_variables=True)
+def test_read_psm4_map_variables():
+    """test read_psm4 map_variables=True"""
+    data, metadata = psm4.read_psm4(MANUAL_TEST_DATA, map_variables=True)
     columns_mapped = ['Year', 'Month', 'Day', 'Hour', 'Minute', 'temp_air',
                       'alpha', 'aod', 'asymmetry', 'dhi_clear', 'dni_clear',
                       'ghi_clear', 'Cloud Fill Flag', 'Cloud Type',
@@ -181,13 +181,13 @@ def test_read_goes4_map_variables():
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_goes4_attribute_mapping(nrel_api_key):
+def test_get_psm4_attribute_mapping(nrel_api_key):
     """Test that pvlib names can be passed in as attributes and get correctly
-    reverse mapped to GOES4 names"""
-    data, meta = goes4.get_goes4(LATITUDE, LONGITUDE, nrel_api_key,
-                                 PVLIB_EMAIL, names=2019, interval=60,
-                                 attributes=['ghi', 'wind_speed'],
-                                 leap_day=False, map_variables=True)
+    reverse mapped to psm4 names"""
+    data, meta = psm4.get_psm4(LATITUDE, LONGITUDE, nrel_api_key,
+                               PVLIB_EMAIL, names=2019, interval=60,
+                               attributes=['ghi', 'wind_speed'],
+                               leap_day=False, map_variables=True)
     # Check that columns are in the correct order (GH1647)
     expected_columns = [
         'Year', 'Month', 'Day', 'Hour', 'Minute', 'ghi', 'wind_speed']