MNT: Add depreciation warning.

act/plotting/geodisplay.py

@@ -3,6 +3,8 @@
 
 """
 
+import warnings
+
 import matplotlib
 import matplotlib.pyplot as plt
 import numpy as np
@@ -59,6 +61,7 @@ def geoplot(
         img_tile=None,
         img_tile_args={},
         tile=8,
+        stamen='terrain-background',
         cartopy_feature=None,
         cmap='rainbow',
         text=None,
@@ -207,9 +210,16 @@ def geoplot(
         else:
             plt.title(title)
 
-        if img_tile is not None:
-            tiler = getattr(img_tiles, img_tile)(**img_tile_args)
-            ax.add_image(tiler, tile)
+        if stamen and img_tile is None:
+           tiler = img_tiles.Stamen(stamen)
+           warnings.warn(
+               "Stamen is deprecated in Cartopy and in future versions of ACT, "
+               "please use img_tile to specify the image background. ")
+        else:
+            if img_tile is not None:
+                tiler = getattr(img_tiles, img_tile)(**img_tile_args)
+
+        ax.add_image(tiler, tile)
 
         colorbar_map = None
         if cmap is not None:

act/tests/test_plotting.py

@@ -430,6 +430,7 @@ def test_geoplot():
             ],
             text={'Ponca City': [-97.0725, 36.7125]},
             img_tile=None,
+            stamen=None,
         )
         try:
             return geodisplay.fig