Merge pull request #257 from raphaelquast/dev

V8.3.2

Author: raphaelquast

.readthedocs.yaml

@@ -1,5 +1,8 @@
 version: 2
 
+sphinx:
+  configuration: docs/source/conf.py
+
 build:
   os: "ubuntu-20.04"
   tools:

docs/source/FAQ.rst

@@ -95,7 +95,7 @@ However, for some editors there are special settings that can be adjusted to imp
 
       To print a snapshot of the current state of a figure to the IPython terminal, call :py:meth:`Maps.show` or :py:meth:`Maps.snapshot`.
 
-    - Similar to Jupyter Notebooks, you can use *"magic"* commands to set the used matpltolib backend.
+    - Similar to Jupyter Notebooks, you can use *"magic"* commands to set the used matplotlib backend.
 
       - For interactive (popup) figures, switch to the default Qt backend using ``%matplotlib qt``
       - For interactive (inline) figures, you'll need to install `ipympl <https://github.com/matplotlib/ipympl>`_ and then activate the ``widget`` with ``%matplotlib widget``.

docs/source/_static/version_switcher.json

@@ -9,8 +9,8 @@
     "url": "https://eomaps.readthedocs.io/en/dev/"
   },
   {
-    "version": "v8.3",
-    "url": "https://eomaps.readthedocs.io/en/v8.3/"
+    "version": "v8.3.2",
+    "url": "https://eomaps.readthedocs.io/en/v8.3.2/"
   },
   {
     "version": "v8.2.1",

docs/source/conf.py

@@ -56,7 +56,7 @@ def mpl_rc_role_subst(name, rawtext, text, lineno, inliner, options={}, content=
 
     node = reference(
         "",
-        f"matpltolib rcParams['{text}']",
+        f"matplotlib rcParams['{text}']",
         refuri=r"https://matplotlib.org/stable/users/explain/customizing.html#matplotlibrc-sample",
     )
     return [node], []

docs/source/user_guide/how_to_use/api_basics.rst

@@ -393,7 +393,7 @@ To adjust the margins of the subplots, use :py:meth:`m.subplots_adjust`, or have
 Multiple Maps/Plots in one Figure
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-It is possible to combine multiple ``EOmaps`` maps and/or ordinary ``matpltolib`` plots in one figure.
+It is possible to combine multiple ``EOmaps`` maps and/or ordinary ``matplotlib`` plots in one figure.
 
 The **figure** used by a :py:class:`Maps` object is set via the ``f`` argument, e.g.: ``m = Maps(f=...)``.
 If no figure is provided, a new figure is created whenever you initialize a :py:class:`Maps` object.
@@ -714,7 +714,7 @@ MapsGrid objects
     the preferred way of combining multiple maps and/or matplotlib axes in a figure
     is by using one of the options presented in the previous sections!
 
-A :py:class:`MapsGrid` creates a grid of :py:class:`Maps` objects (and/or ordinary ``matpltolib`` axes),
+A :py:class:`MapsGrid` creates a grid of :py:class:`Maps` objects (and/or ordinary ``matplotlib`` axes),
 and provides convenience-functions to perform actions on all maps of the figure.
 
 .. code-block:: python
@@ -768,7 +768,7 @@ of the following structure:
 - ``m_inits`` is used to initialize :py:class:`Maps` objects
 - ``ax_inits`` is used to initialize ordinary ``matplotlib`` axes
 
-The individual :py:class:`Maps` objects and ``matpltolib-Axes`` are then accessible via:
+The individual :py:class:`Maps` objects and ``matplotlib-Axes`` are then accessible via:
 
 .. code-block:: python
     :name: test_mapsgrid_custom

docs/source/user_guide/how_to_use/api_data_visualization.rst

@@ -878,7 +878,7 @@ Colors can also be set **manually** by providing one of the following arguments
 Uniform colors
 **************
 
-To apply a uniform color to all datapoints, you can use `matpltolib's named colors <https://matplotlib.org/stable/gallery/color/named_colors.html>`_ or pass an RGB or RGBA tuple.
+To apply a uniform color to all datapoints, you can use `matplotlib's named colors <https://matplotlib.org/stable/gallery/color/named_colors.html>`_ or pass an RGB or RGBA tuple.
 
 - ``m.plot_map(fc="orange")``
 - ``m.plot_map(fc=(0.4, 0.3, 0.2))``

eomaps/_blit_manager.py

@@ -1081,7 +1081,7 @@ def remove_artist(self, art, layer=None):
 
         Parameters
         ----------
-        art : matpltolib.Artist
+        art : matplotlib.Artist
             The artist to remove.
         layer : str, optional
             The layer to search for the artist. If None, all layers are searched.
@@ -1403,7 +1403,7 @@ def blit_artists(self, artists, bg="active", blit=True):
         ----------
         artists : iterable
             the artists to draw
-        bg : matpltolib.BufferRegion, None or "active", optional
+        bg : matplotlib.BufferRegion, None or "active", optional
             A fetched background that is restored before drawing the artists.
             The default is "active".
         blit : bool

eomaps/_maps_base.py

@@ -439,21 +439,14 @@ def parent(self):
 
     def _init_figure(self, **kwargs):
         if self.parent.f is None:
-            # do this on any new figure since "%matpltolib inline" tries to re-activate
+            # do this on any new figure since "%matplotlib inline" tries to re-activate
             # interactive mode all the time!
             _handle_backends()
 
             self._f = plt.figure(**kwargs)
             # to hide canvas header in jupyter notebooks (default figure label)
             self._f.canvas.header_visible = False
 
-            # override Figure.savefig with Maps.savefig but keep original
-            # method accessible via Figure._mpl_orig_savefig
-            # (this ensures that using the save-buttons in the gui or pressing
-            # control+s will redirect the save process to the eomaps routine)
-            self._f._mpl_orig_savefig = self._f.savefig
-            self._f.savefig = self.savefig
-
             _log.debug("EOmaps: New figure created")
 
             # make sure we keep a "real" reference otherwise overwriting the
@@ -466,6 +459,14 @@ def _init_figure(self, **kwargs):
             self.parent._add_child(self)
 
         if self.parent == self:  # use == instead of "is" since the parent is a proxy!
+
+            # override Figure.savefig with Maps.savefig but keep original
+            # method accessible via Figure._mpl_orig_savefig
+            # (this ensures that using the save-buttons in the gui or pressing
+            # control+s will redirect the save process to the eomaps routine)
+            self._f._mpl_orig_savefig = self._f.savefig
+            self._f.savefig = self.savefig
+
             # only attach resize- and close-callbacks if we initialize a parent
             # Maps-object
             # attach a callback that is executed when the figure is closed
@@ -1160,6 +1161,20 @@ def crs_plot(self):
     @staticmethod
     @lru_cache()
     def _get_cartopy_crs(crs):
+        if isinstance(crs, str):
+            try:
+                # TODO use crs=int(crs.upper().removeprefix("EPSG:")) when python>=3.9
+                # is required
+                crs = crs.upper()
+                if crs.startswith("EPSG:"):
+                    crs = crs[5:]
+                crs = int(crs)
+            except ValueError:
+                raise ValueError(
+                    f"The provided crs '{crs}' cannot be identified. "
+                    "If a string is provided as CRS, it must be either an integer "
+                    "(e.g. '4326') or a string of the form: 'EPSG:4326'."
+                )
         if isinstance(crs, ccrs.CRS):  # already a cartopy CRS
             cartopy_proj = crs
         elif crs == 4326:

eomaps/_webmap.py

@@ -132,7 +132,7 @@ def add_legend(self, style=None, img=None):
 
         Returns
         -------
-        legax : matpltolib.axes
+        legax : matplotlib.axes
             The axes-object.
 
         """

eomaps/colorbar.py

@@ -10,7 +10,7 @@
 
 import numpy as np
 
-from .helpers import _TransformedBoundsLocator, pairwise
+from .helpers import _TransformedBoundsLocator, pairwise, version, mpl_version
 
 import logging
 
@@ -943,7 +943,13 @@ def indicate_contours(
         else:
             coll = contour_map.coll
 
-        if not coll.__class__.__name__ == "_CollectionAccessor":
+        # TODO remove this once mpl >=3.10 is required
+        if mpl_version < version.Version("3.10"):
+            expected_collections = ["_CollectionAccessor"]
+        else:
+            expected_collections = ["ContourSet", "TriContourSet", "GeoContourSet"]
+
+        if not coll.__class__.__name__ in expected_collections:
             raise TypeError(
                 "EOmaps: Contour-lines can only be added to the colorbar if a contour "
                 "was plotted first! If you want to indicate contours plotted on a "
@@ -958,7 +964,11 @@ def indicate_contours(
                 exclude_levels[i] = len(levels) + val
 
         if colors is None:
-            if coll._filled is False:
+            # _filled is required for mpl <3.10 (e.g. _CollectionAccessor)
+            # TODO use only "coll.filled" once mpl >=3.10 is required
+            filled = coll._filled if hasattr(coll, "_filled") else coll.filled
+
+            if filled is False:
                 colors = (
                     np.array(coll.get_edgecolors(), dtype=object).squeeze().tolist()
                 )