add Mount classes

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

@@ -100,6 +100,10 @@ Deprecations
   * ``PVSystem.surface_azimuth``
   * ``PVSystem.temperature_model_parameters``
 
+* The :py:class:`pvlib.tracking.SingleAxisTracker` class is deprecated and
+  replaced by using :py:class:`pvlib.pvsystem.PVSystem` with the new
+  :py:class:`pvlib.pvsystem.SingleAxisTrackerMount` (:pull:`1176`)
+
 
 Enhancements
 ~~~~~~~~~~~~

pvlib/tests/test_modelchain.py

@@ -734,12 +734,13 @@ def test_run_model_with_weather_noct_sam_temp(sapm_dc_snl_ac_system, location,
 
 
 def test_run_model_tracker(sapm_dc_snl_ac_system, location, weather, mocker):
-    system = SingleAxisTracker(
-        module_parameters=sapm_dc_snl_ac_system.arrays[0].module_parameters,
-        temperature_model_parameters=(
-            sapm_dc_snl_ac_system.arrays[0].temperature_model_parameters
-        ),
-        inverter_parameters=sapm_dc_snl_ac_system.inverter_parameters)
+    with pytest.warns(pvlibDeprecationWarning):
+        system = SingleAxisTracker(
+            module_parameters=sapm_dc_snl_ac_system.arrays[0].module_parameters,
+            temperature_model_parameters=(
+                sapm_dc_snl_ac_system.arrays[0].temperature_model_parameters
+            ),
+            inverter_parameters=sapm_dc_snl_ac_system.inverter_parameters)
     mocker.spy(system, 'singleaxis')
     mc = ModelChain(system, location)
     mc.run_model(weather)
@@ -755,12 +756,13 @@ def test_run_model_tracker(sapm_dc_snl_ac_system, location, weather, mocker):
 
 def test_run_model_tracker_list(
         sapm_dc_snl_ac_system, location, weather, mocker):
-    system = SingleAxisTracker(
-        module_parameters=sapm_dc_snl_ac_system.arrays[0].module_parameters,
-        temperature_model_parameters=(
-            sapm_dc_snl_ac_system.arrays[0].temperature_model_parameters
-        ),
-        inverter_parameters=sapm_dc_snl_ac_system.inverter_parameters)
+    with pytest.warns(pvlibDeprecationWarning):
+        system = SingleAxisTracker(
+            module_parameters=sapm_dc_snl_ac_system.arrays[0].module_parameters,
+            temperature_model_parameters=(
+                sapm_dc_snl_ac_system.arrays[0].temperature_model_parameters
+            ),
+            inverter_parameters=sapm_dc_snl_ac_system.inverter_parameters)
     mocker.spy(system, 'singleaxis')
     mc = ModelChain(system, location)
     mc.run_model([weather])
@@ -1027,12 +1029,13 @@ def test_run_model_from_poa_arrays_solar_position_weather(
 
 def test_run_model_from_poa_tracking(sapm_dc_snl_ac_system, location,
                                      total_irrad):
-    system = SingleAxisTracker(
-        module_parameters=sapm_dc_snl_ac_system.arrays[0].module_parameters,
-        temperature_model_parameters=(
-            sapm_dc_snl_ac_system.arrays[0].temperature_model_parameters
-        ),
-        inverter_parameters=sapm_dc_snl_ac_system.inverter_parameters)
+    with pytest.warns(pvlibDeprecationWarning):
+        system = SingleAxisTracker(
+            module_parameters=sapm_dc_snl_ac_system.arrays[0].module_parameters,
+            temperature_model_parameters=(
+                sapm_dc_snl_ac_system.arrays[0].temperature_model_parameters
+            ),
+            inverter_parameters=sapm_dc_snl_ac_system.inverter_parameters)
     mc = ModelChain(system, location, aoi_model='no_loss',
                     spectral_model='no_loss')
     ac = mc.run_model_from_poa(total_irrad).results.ac

pvlib/tests/test_tracking.py

@@ -8,6 +8,7 @@
 import pvlib
 from pvlib import tracking
 from .conftest import DATA_DIR, assert_frame_equal
+from pvlib._deprecation import pvlibDeprecationWarning
 
 SINGLEAXIS_COL_ORDER = ['tracker_theta', 'aoi',
                         'surface_azimuth', 'surface_tilt']
@@ -289,22 +290,11 @@ def test_low_sun_angles():
         assert_allclose(expected[k], v)
 
 
-def test_SingleAxisTracker_creation():
-    system = tracking.SingleAxisTracker(max_angle=45,
-                                        gcr=.25,
-                                        module='blah',
-                                        inverter='blarg')
-
-    assert system.max_angle == 45
-    assert system.gcr == .25
-    assert system.arrays[0].module == 'blah'
-    assert system.inverter == 'blarg'
-
-
 def test_SingleAxisTracker_tracking():
-    system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
-                                        axis_azimuth=180, gcr=2.0/7.0,
-                                        backtrack=True)
+    with pytest.warns(pvlibDeprecationWarning):
+        system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
+                                            axis_azimuth=180, gcr=2.0/7.0,
+                                            backtrack=True)
 
     apparent_zenith = pd.Series([30])
     apparent_azimuth = pd.Series([135])
@@ -324,9 +314,10 @@ def test_SingleAxisTracker_tracking():
     pvsyst_solar_height = 27.315
     pvsyst_axis_tilt = 20.
     pvsyst_axis_azimuth = 20.
-    pvsyst_system = tracking.SingleAxisTracker(
-        max_angle=60., axis_tilt=pvsyst_axis_tilt,
-        axis_azimuth=180+pvsyst_axis_azimuth, backtrack=False)
+    with pytest.warns(pvlibDeprecationWarning):
+        pvsyst_system = tracking.SingleAxisTracker(
+            max_angle=60., axis_tilt=pvsyst_axis_tilt,
+            axis_azimuth=180+pvsyst_axis_azimuth, backtrack=False)
     # the definition of azimuth is different from PYsyst
     apparent_azimuth = pd.Series([180+pvsyst_solar_azimuth])
     apparent_zenith = pd.Series([90-pvsyst_solar_height])
@@ -342,9 +333,10 @@ def test_SingleAxisTracker_tracking():
 
 # see test_irradiance for more thorough testing
 def test_get_aoi():
-    system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
-                                        axis_azimuth=180, gcr=2.0/7.0,
-                                        backtrack=True)
+    with pytest.warns(pvlibDeprecationWarning):
+        system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
+                                            axis_azimuth=180, gcr=2.0/7.0,
+                                            backtrack=True)
     surface_tilt = np.array([30, 0])
     surface_azimuth = np.array([90, 270])
     solar_zenith = np.array([70, 10])
@@ -356,9 +348,10 @@ def test_get_aoi():
 
 
 def test_get_irradiance():
-    system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
-                                        axis_azimuth=180, gcr=2.0/7.0,
-                                        backtrack=True)
+    with pytest.warns(pvlibDeprecationWarning):
+        system = tracking.SingleAxisTracker(max_angle=90, axis_tilt=30,
+                                            axis_azimuth=180, gcr=2.0/7.0,
+                                            backtrack=True)
     times = pd.date_range(start='20160101 1200-0700',
                           end='20160101 1800-0700', freq='6H')
     # latitude=32, longitude=-111
@@ -402,9 +395,10 @@ def test_get_irradiance():
 
 
 def test_SingleAxisTracker___repr__():
-    system = tracking.SingleAxisTracker(
-        max_angle=45, gcr=.25, module='blah', inverter='blarg',
-        temperature_model_parameters={'a': -3.56})
+    with pytest.warns(pvlibDeprecationWarning):
+        system = tracking.SingleAxisTracker(
+            max_angle=45, gcr=.25, module='blah', inverter='blarg',
+            temperature_model_parameters={'a': -3.56})
     expected = """SingleAxisTracker:
   axis_tilt: 0
   axis_azimuth: 0

pvlib/tracking.py

@@ -6,8 +6,10 @@
     PVSystem, Array, SingleAxisTrackerMount, _unwrap_single_value
 )
 from pvlib import irradiance, atmosphere
+from pvlib._deprecation import deprecated
 
 
+@deprecated('0.9.0', alternative='PVSystem with SingleAxisTrackingMount')
 class SingleAxisTracker(PVSystem):
     """
     A class for single-axis trackers that inherits the PV modeling methods from