Remove tutorial.load_dataset

as planned for 0.12; and remove remaining uses in docs and examples.

Author: Zac-HD

doc/examples/monthly-means.rst

@@ -92,7 +92,7 @@ Open the ``Dataset``
 
 .. code:: python
 
-    ds = xr.tutorial.load_dataset('rasm')
+    ds = xr.tutorial.open_dataset('rasm').load()
     print(ds)
 
 

doc/gallery/plot_cartopy_facetgrid.py

@@ -22,7 +22,7 @@
 import xarray as xr
 
 # Load the data
-ds = xr.tutorial.load_dataset('air_temperature')
+ds = xr.tutorial.open_dataset('air_temperature')
 air = ds.air.isel(time=[0, 724]) - 273.15
 
 # This is the map projection we want to plot *onto*

doc/gallery/plot_colorbar_center.py

@@ -13,7 +13,7 @@
 import xarray as xr
 
 # Load the data
-ds = xr.tutorial.load_dataset('air_temperature')
+ds = xr.tutorial.open_dataset('air_temperature')
 air = ds.air.isel(time=0)
 
 f, ((ax1, ax2), (ax3, ax4)) = plt.subplots(2, 2, figsize=(8, 6))

doc/gallery/plot_control_colorbar.py

@@ -12,7 +12,7 @@
 import xarray as xr
 
 # Load the data
-air_temp = xr.tutorial.load_dataset('air_temperature')
+air_temp = xr.tutorial.open_dataset('air_temperature')
 air2d = air_temp.air.isel(time=500)
 
 # Prepare the figure

doc/gallery/plot_lines_from_2d.py

@@ -17,7 +17,7 @@
 import xarray as xr
 
 # Load the data
-ds = xr.tutorial.load_dataset('air_temperature')
+ds = xr.tutorial.open_dataset('air_temperature')
 air = ds.air - 273.15  # to celsius
 
 # Prepare the figure

doc/whats-new.rst

@@ -30,6 +30,10 @@ Breaking changes
   By `Maximilian Roos <https://github.com/max-sixty>`_.
 - `cyordereddict` is no longer used as an optional dependency (:issue:`2744`).
   By `Joe Hamman <https://github.com/jhamman>`_.
+- ``xarray.tutorial.load_dataset`` has been removed as scheduled in Xarray 0.11.
+  Instead, you can use ``tutorial.open_dataset(...).load()`` which allows you
+  to use tutorial datasets with dask.
+  By `Zac Hatfield-Dodds <https://github.com/Zac-HD>`_.
 
 Enhancements
 ~~~~~~~~~~~~

xarray/tutorial.py

@@ -87,20 +87,3 @@ def open_dataset(name, cache=True, cache_dir=_default_cache_dir,
         _os.remove(localfile)
 
     return ds
-
-
-def load_dataset(*args, **kwargs):
-    """
-    `load_dataset` will be removed in version 0.12. The current behavior of
-    this function can be achived by using `tutorial.open_dataset(...).load()`.
-
-    See Also
-    --------
-    open_dataset
-    """
-    warnings.warn(
-        "load_dataset` will be removed in xarray version 0.12. The current "
-        "behavior of this function can be achived by using "
-        "`tutorial.open_dataset(...).load()`.",
-        DeprecationWarning, stacklevel=2)
-    return open_dataset(*args, **kwargs).load()