Address wholmgren's review on PR #2705

- Rename nrel_api_key fixture to nlr_api_key directly (no alias)
- Simplify fixture: check NLR_API_KEY, warn with DEMO_KEY fallback
  (no NREL_API_KEY deprecation logic)
- Update test_psm4.py to use nlr_api_key fixture
- Remove NREL_API_KEY from CI workflow
- Update whatsnew: remove fallback mention, link nrel_nlr doc page

Author: jason-curtis

.github/workflows/pytest-remote-data.yml

@@ -97,7 +97,6 @@ jobs:
         env:
           # copy GitHub Secrets into environment variables for the tests to access
           NLR_API_KEY: ${{ secrets.NRELAPIKEY }}
-          NREL_API_KEY: ${{ secrets.NRELAPIKEY }}
           SOLARANYWHERE_API_KEY: ${{ secrets.SOLARANYWHERE_API_KEY }}
           BSRN_FTP_USERNAME: ${{ secrets.BSRN_FTP_USERNAME }}
           BSRN_FTP_PASSWORD: ${{ secrets.BSRN_FTP_PASSWORD }}

docs/sphinx/source/whatsnew/v0.15.1.rst

@@ -58,8 +58,9 @@ Maintenance
 ~~~~~~~~~~~
 * Update all NREL references to NLR (National Laboratory of the Rockies)
   following the laboratory rename and domain migration from ``nrel.gov``
-  to ``nlr.gov``. Add ``NLR_API_KEY`` environment variable support with
-  ``NREL_API_KEY`` fallback. (:issue:`2701`, :pull:`2705`)
+  to ``nlr.gov``. Rename ``NREL_API_KEY`` environment variable to
+  ``NLR_API_KEY``. See :ref:`nrel_nlr` for details.
+  (:issue:`2701`, :pull:`2705`)
 
 
 Contributors

tests/conftest.py

@@ -86,33 +86,27 @@ def assert_frame_equal(left, right, **kwargs):
 
 
 @pytest.fixture(scope="module")
-def nrel_api_key():
-    """API key for NLR Developer Network (formerly NREL).
-
-    Checks NLR_API_KEY first, falls back to NREL_API_KEY
-    with deprecation warning.
+def nlr_api_key():
+    """Supplies pvlib-python's NLR Developer Network API key.
+
+    pvlib's CI utilizes a secret variable set to NLR_API_KEY
+    (formerly NREL_API_KEY) to mitigate failures associated with
+    using the default key of "DEMO_KEY". A user is capable of using
+    their own key this way if desired however the default key should
+    suffice for testing purposes.
     """
     try:
         demo_key = os.environ["NLR_API_KEY"]
     except KeyError:
-        try:
-            demo_key = os.environ["NREL_API_KEY"]
-            warnings.warn(
-                "NREL_API_KEY is deprecated, use NLR_API_KEY instead",
-                DeprecationWarning,
-                stacklevel=2,
-            )
-        except KeyError:
-            pytest.skip("requires NLR_API_KEY or NREL_API_KEY env var")
+        warnings.warn(
+            "WARNING: NLR_API_KEY (formerly NREL_API_KEY) environment "
+            "variable not set! Using DEMO_KEY instead. "
+            "Unexpected failures may occur."
+        )
+        demo_key = 'DEMO_KEY'
     return demo_key
 
 
-@pytest.fixture(scope="module")
-def nlr_api_key(nrel_api_key):
-    """Alias for nrel_api_key fixture."""
-    return nrel_api_key
-
-
 try:
     # Attempt to load BSRN credentials used for testing pvlib.iotools.get_bsrn
     bsrn_username = os.environ["BSRN_FTP_USERNAME"]

tests/iotools/test_psm4.py

@@ -4,7 +4,7 @@
 
 from pvlib.iotools import psm4
 from ..conftest import (
-    TESTS_DATA_DIR, RERUNS, RERUNS_DELAY, assert_index_equal, nrel_api_key
+    TESTS_DATA_DIR, RERUNS, RERUNS_DELAY, assert_index_equal, nlr_api_key
 )
 import numpy as np
 import pandas as pd
@@ -54,10 +54,10 @@ def assert_psm4_equal(data, metadata, expected):
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_nsrdb_psm4_tmy(nrel_api_key):
+def test_get_nsrdb_psm4_tmy(nlr_api_key):
     """test get_nsrdb_psm4_tmy with a TMY"""
     data, metadata = psm4.get_nsrdb_psm4_tmy(LATITUDE, LONGITUDE,
-                                             nrel_api_key, PVLIB_EMAIL,
+                                             nlr_api_key, PVLIB_EMAIL,
                                              year='tmy-2023',
                                              leap_day=False,
                                              map_variables=False)
@@ -67,10 +67,10 @@ def test_get_nsrdb_psm4_tmy(nrel_api_key):
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_nsrdb_psm4_full_disc(nrel_api_key):
+def test_get_nsrdb_psm4_full_disc(nlr_api_key):
     """test get_nsrdb_psm4_full_disc with a single year"""
     data, metadata = psm4.get_nsrdb_psm4_full_disc(LATITUDE, LONGITUDE,
-                                                   nrel_api_key, PVLIB_EMAIL,
+                                                   nlr_api_key, PVLIB_EMAIL,
                                                    year='2023',
                                                    leap_day=False,
                                                    map_variables=False)
@@ -80,10 +80,10 @@ def test_get_nsrdb_psm4_full_disc(nrel_api_key):
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_nsrdb_psm4_conus_singleyear(nrel_api_key):
+def test_get_nsrdb_psm4_conus_singleyear(nlr_api_key):
     """test get_nsrdb_psm4_conus with a single year"""
     data, metadata = psm4.get_nsrdb_psm4_aggregated(LATITUDE, LONGITUDE,
-                                                    nrel_api_key,
+                                                    nlr_api_key,
                                                     PVLIB_EMAIL,
                                                     year='2023',
                                                     leap_day=False,
@@ -95,10 +95,10 @@ def test_get_nsrdb_psm4_conus_singleyear(nrel_api_key):
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_nsrdb_psm4_conus_5min(nrel_api_key):
+def test_get_nsrdb_psm4_conus_5min(nlr_api_key):
     """test get_nsrdb_psm4_conus for 5-minute data"""
     data, metadata = psm4.get_nsrdb_psm4_conus(LATITUDE, LONGITUDE,
-                                               nrel_api_key, PVLIB_EMAIL,
+                                               nlr_api_key, PVLIB_EMAIL,
                                                year='2023', time_step=5,
                                                leap_day=False,
                                                map_variables=False)
@@ -110,10 +110,10 @@ def test_get_nsrdb_psm4_conus_5min(nrel_api_key):
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_nsrdb_psm4_aggregated_check_leap_day(nrel_api_key):
+def test_get_nsrdb_psm4_aggregated_check_leap_day(nlr_api_key):
     """test get_nsrdb_psm4_aggregated for leap day"""
     data_2012, _ = psm4.get_nsrdb_psm4_aggregated(LATITUDE, LONGITUDE,
-                                                  nrel_api_key, PVLIB_EMAIL,
+                                                  nlr_api_key, PVLIB_EMAIL,
                                                   year="2012", time_step=60,
                                                   leap_day=True,
                                                   map_variables=False)
@@ -122,9 +122,9 @@ def test_get_nsrdb_psm4_aggregated_check_leap_day(nrel_api_key):
 
 @pytest.mark.parametrize('latitude, longitude, api_key, year, time_step',
                          [(LATITUDE, LONGITUDE, 'BAD', '2023', 60),
-                          (51, -5, nrel_api_key, '2023', 60),
-                          (LATITUDE, LONGITUDE, nrel_api_key, 'bad', 60),
-                          (LATITUDE, LONGITUDE, nrel_api_key, '2023', 15),
+                          (51, -5, nlr_api_key, '2023', 60),
+                          (LATITUDE, LONGITUDE, nlr_api_key, 'bad', 60),
+                          (LATITUDE, LONGITUDE, nlr_api_key, '2023', 15),
                           ])
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
@@ -187,11 +187,11 @@ def test_read_nsrdb_psm4_map_variables():
 
 @pytest.mark.remote_data
 @pytest.mark.flaky(reruns=RERUNS, reruns_delay=RERUNS_DELAY)
-def test_get_nsrdb_psm4_aggregated_parameter_mapping(nrel_api_key):
+def test_get_nsrdb_psm4_aggregated_parameter_mapping(nlr_api_key):
     """Test that pvlib names can be passed in as parameters and get correctly
     reverse mapped to psm4 names"""
     data, meta = psm4.get_nsrdb_psm4_aggregated(
-        LATITUDE, LONGITUDE, nrel_api_key, PVLIB_EMAIL, year='2019',
+        LATITUDE, LONGITUDE, nlr_api_key, PVLIB_EMAIL, year='2019',
         time_step=60, parameters=['ghi', 'wind_speed'], leap_day=False,
         map_variables=True)
     # Check that columns are in the correct order (GH1647)