Remove default cmap of "jet"

This will fall back to matplotlibs configured default, which is usually
'viridis' but can be customised by users. "jet" is a poor choice for
many reasons.

Author: mx-moth

docs/_static/images/gbr4_temp.png

@@ -130,7 +130,7 @@ def add_landmarks(
         # Plot the temperature
         temperature = dataset.ems.make_poly_collection(
             dataset['temp'].isel(time=0, k=-1),
-            cmap='jet', edgecolor='face', zorder=0)
+            cmap='viridis', edgecolor='face', zorder=0)
         axes.add_collection(temperature)
         figure.colorbar(temperature, label='°C')
 
@@ -321,7 +321,7 @@ def plot_on_figure(
     if scalar is not None:
         # Plot a scalar variable on the polygons using a colour map
         collection = convention.make_poly_collection(
-            scalar, cmap='jet', edgecolor='face')
+            scalar, edgecolor='face')
         axes.add_collection(collection)
         units = scalar.attrs.get('units')
         figure.colorbar(collection, ax=axes, location='right', label=units)
@@ -437,7 +437,7 @@ def animate_on_figure(
         # Plot a scalar variable on the polygons using a colour map
         scalar_values = convention.ravel(scalar).values[:, convention.mask]
         collection = convention.make_poly_collection(
-            cmap='jet', edgecolor='face',
+            edgecolor='face',
             clim=(numpy.nanmin(scalar_values), numpy.nanmax(scalar_values)))
         axes.add_collection(collection)
         collection.set_animated(True)

src/emsarray/plot.py

@@ -8,7 +8,7 @@
 import shapely
 import xarray
 from cartopy import crs
-from matplotlib import animation, colormaps, pyplot
+from matplotlib import animation, pyplot
 from matplotlib.artist import Artist
 from matplotlib.axes import Axes
 from matplotlib.collections import PolyCollection
@@ -558,7 +558,7 @@ def plot_on_figure(
         trim_nans: bool = True,
         clamp_to_surface: bool = True,
         bathymetry: xarray.DataArray | None = None,
-        cmap: str | Colormap = 'jet',
+        cmap: str | Colormap | None = None,
         clim: tuple[float, float] | None = None,
         ocean_floor_colour: str = 'black',
         landmarks: list[Landmark] | None = None,
@@ -620,7 +620,7 @@ def animate_on_figure(
         trim_nans: bool = True,
         clamp_to_surface: bool = True,
         bathymetry: xarray.DataArray | None = None,
-        cmap: str | Colormap = 'jet',
+        cmap: str | Colormap | None = None,
         clim: tuple[float, float] | None = None,
         ocean_floor_colour: str = 'black',
         landmarks: list[Landmark] | None = None,
@@ -717,7 +717,7 @@ def _plot_on_figure(
         trim_nans: bool = True,
         clamp_to_surface: bool = True,
         bathymetry: xarray.DataArray | None = None,
-        cmap: str | Colormap = 'jet',
+        cmap: str | Colormap | None = None,
         clim: tuple[float, float] | None = None,
         ocean_floor_colour: str = 'black',
         landmarks: list[Landmark] | None = None,
@@ -774,8 +774,7 @@ def _plot_on_figure(
         if title is not None:
             axes.set_title(title)
 
-        if isinstance(cmap, str):
-            cmap = colormaps[cmap].copy()
+        cmap = pyplot.get_cmap(cmap).copy()
         cmap.set_bad(ocean_floor_colour)
 
         # Find a min/max from the data if clim isn't provided and the data array is not empty.