Remove read_srml_month_from_solardat

pvlib · AdamRJensen · Jun 6, 2024 · Mar 12, 2024 · May 24, 2024 · May 24, 2024
commit 0cb48265bf9cb45b207863b7c6f9963a918116aa
diff --git a/docs/sphinx/source/reference/iotools.rst b/docs/sphinx/source/reference/iotools.rst
@@ -19,7 +19,6 @@ of sources and file formats relevant to solar energy modeling.
    iotools.read_epw
    iotools.parse_epw
    iotools.read_srml
-   iotools.read_srml_month_from_solardat
    iotools.get_srml
    iotools.read_surfrad
    iotools.read_midc

diff --git a/pvlib/iotools/__init__.py b/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

diff --git a/pvlib/iotools/srml.py b/pvlib/iotools/srml.py
@@ -172,64 +172,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.

diff --git a/pvlib/tests/iotools/test_srml.py b/pvlib/tests/iotools/test_srml.py
@@ -89,50 +89,6 @@ def test_get_srml():
     assert_frame_equal(file_data, requested)
 
 
-@pytest.mark.skip(reason="SRML server is undergoing maintenance as of 12-2023")
-@fail_on_pvlib_version('0.11')
-@pytest.mark.remote_data
-@pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_read_srml_month_from_solardat():
-    url = 'http://solardat.uoregon.edu/download/Archive/EUPO1801.txt'
-    file_data = srml.read_srml(url)
-    with pytest.warns(pvlibDeprecationWarning, match='get_srml instead'):
-        requested = srml.read_srml_month_from_solardat('EU', 2018, 1)
-    assert file_data.equals(requested)
-
-
-@pytest.mark.skip(reason="SRML server is undergoing maintenance as of 12-2023")
-@fail_on_pvlib_version('0.11')
-@pytest.mark.remote_data
-@pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_15_minute_dt_index():
-    with pytest.warns(pvlibDeprecationWarning, match='get_srml instead'):
-        data = srml.read_srml_month_from_solardat('TW', 2019, 4, 'RQ')
-    start = pd.Timestamp('20190401 00:00')
-    start = start.tz_localize('Etc/GMT+8')
-    end = pd.Timestamp('20190430 23:45')
-    end = end.tz_localize('Etc/GMT+8')
-    assert data.index[0] == start
-    assert data.index[-1] == end
-    assert (data.index[3::4].minute == 45).all()
-
-
-@pytest.mark.skip(reason="SRML server is undergoing maintenance as of 12-2023")
-@fail_on_pvlib_version('0.11')
-@pytest.mark.remote_data
-@pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_hourly_dt_index():
-    with pytest.warns(pvlibDeprecationWarning, match='get_srml instead'):
-        data = srml.read_srml_month_from_solardat('CD', 1986, 4, 'PH')
-    start = pd.Timestamp('19860401 00:00')
-    start = start.tz_localize('Etc/GMT+8')
-    end = pd.Timestamp('19860430 23:00')
-    end = end.tz_localize('Etc/GMT+8')
-    assert data.index[0] == start
-    assert data.index[-1] == end
-    assert (data.index.minute == 0).all()
-
-
 @pytest.mark.skip(reason="SRML server is undergoing maintenance as of 12-2023")
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)