Removing pyvista dependency (#1066)

* Disabling '_get_sg_image_scraper'

* lazy import of pyvista, and checks when vtk=true

* Moving eplot to mapdl with the other Xplot functions

* Making pyvista a lazy import in general plotter.

* Making pyvista and pyiges optional in the report.

* Avoiding passing extra general_plotter kwargs to mapdl._run.

* Fixing unit tests

* Improvements in the coverage tests.

* Improving coverage

* Fixing unit tests

* Improving coverage

Author: germa89

src/ansys/mapdl/core/__init__.py

@@ -12,7 +12,13 @@
 _LOCAL_PORTS = []
 
 # Per contract with Sphinx-Gallery, this method must be available at top level
-from pyvista.utilities.sphinx_gallery import _get_sg_image_scraper
+try:
+    from pyvista.utilities.sphinx_gallery import _get_sg_image_scraper
+
+    _HAS_PYVISTA = True
+except ModuleNotFoundError:  # pragma: no cover
+    LOG.debug("The module 'Pyvista' is not installed.")
+    _HAS_PYVISTA = False
 
 try:
     import importlib.metadata as importlib_metadata

src/ansys/mapdl/core/_commands/preproc/elements.py

@@ -1,9 +1,7 @@
 from typing import Optional, Union
-import warnings
 
 from ansys.mapdl.core._commands.parse import parse_e
 from ansys.mapdl.core.mapdl_types import MapdlFloat, MapdlInt
-from ansys.mapdl.core.plotting import general_plotter
 
 
 class Elements:
@@ -1233,74 +1231,29 @@ def ensym(
         """
         return self.run(f"ENSYM,{iinc},,{ninc},{iel1},{iel2},{ieinc}", **kwargs)
 
-    def eplot(self, show_node_numbering=False, vtk=None, **kwargs):
+    def eplot(self, **kwargs):
         """Plots the currently selected elements.
 
         APDL Command: EPLOT
 
-        .. note::
-            PyMAPDL plotting commands with ``vtk=True`` ignore any
-            values set with the ``PNUM`` command.
-
-        Parameters
-        ----------
-        vtk : bool, optional
-            Plot the currently selected elements using ``pyvista``.
-            Defaults to current ``use_vtk`` setting.
-
-        show_node_numbering : bool, optional
-            Plot the node numbers of surface nodes.
-
-        **kwargs
-            See ``help(ansys.mapdl.core.plotter.general_plotter)`` for more
-            keyword arguments related to visualizing using ``vtk``.
-
-        Examples
-        --------
-        >>> mapdl.clear()
-        >>> mapdl.prep7()
-        >>> mapdl.block(0, 1, 0, 1, 0, 1)
-        >>> mapdl.et(1, 186)
-        >>> mapdl.esize(0.1)
-        >>> mapdl.vmesh('ALL')
-        >>> mapdl.vgen(2, 'all')
-        >>> mapdl.eplot(show_edges=True, smooth_shading=True,
-                        show_node_numbering=True)
-
-        Save a screenshot to disk without showing the plot
-
-        >>> mapdl.eplot(background='w', show_edges=True, smooth_shading=True,
-                        window_size=[1920, 1080], savefig='screenshot.png',
-                        off_screen=True)
+        Notes
+        ------
+        Produces an element display of the selected elements. In full
+        graphics, only those elements faces with all of their corresponding
+        nodes selected are plotted. In PowerGraphics, all element faces of the selected
+        element set are plotted irrespective of the nodes selected. However,
+        for both full graphics and Power Graphics, adjacent or otherwise
+        duplicated faces of 3-D solid elements will not be displayed in an attempt
+        to eliminate plotting of interior facets. See the ``DSYS`` command for display
+        coordinate system issues.
+        This command will display curvature in midside node elements when PowerGraphics is activated
+        [``/GRAPHICS ,POWER``] and ``/EFACET,2`` or ``/EFACET,4`` are enabled. (To display
+        curvature, two facets per edge is recommended [``/EFACET,2``]). When you specify ``/EFACET,1``,
+        PowerGraphics does not display midside nodes. ``/EFACET`` has no effect on EPLOT for non-midside
+        node elements.
+        This command is valid in any processor.
 
         """
-        if vtk is None:
-            vtk = self._use_vtk
-
-        if vtk:
-            kwargs.setdefault("title", "MAPDL Element Plot")
-            if not self._mesh.n_elem:
-                warnings.warn("There are no elements to plot.")
-                return general_plotter([], [], [], **kwargs)
-
-            # TODO: Consider caching the surface
-            esurf = self.mesh._grid.linear_copy().extract_surface().clean()
-            kwargs.setdefault("show_edges", True)
-
-            # if show_node_numbering:
-            labels = []
-            if show_node_numbering:
-                labels = [{"points": esurf.points, "labels": esurf["ansys_node_num"]}]
-
-            return general_plotter(
-                [{"mesh": esurf, "style": kwargs.pop("style", "surface")}],
-                [],
-                labels,
-                **kwargs,
-            )
-
-        # otherwise, use MAPDL plotter
-        self._enable_interactive_plotting()
         return self.run("EPLOT")
 
     def eread(self, fname: str = "", ext: str = "", **kwargs) -> Optional[str]:

src/ansys/mapdl/core/mapdl.py

@@ -18,6 +18,7 @@
 
 from ansys.mapdl import core as pymapdl
 from ansys.mapdl.core import LOG as logger
+from ansys.mapdl.core import _HAS_PYVISTA
 from ansys.mapdl.core.commands import (
     CMD_BC_LISTING,
     CMD_LISTING,
@@ -149,7 +150,17 @@ def __init__(
         self._store_commands = False
         self._stored_commands = []
         self._response = None
-        self._use_vtk = use_vtk
+
+        if _HAS_PYVISTA:
+            self._use_vtk = use_vtk
+        else:  # pragma: no cover
+            if use_vtk:
+                raise ModuleNotFoundError(
+                    f"Using the keyword argument 'use_vtk' requires having Pyvista installed."
+                )
+            else:
+                self._use_vtk = False
+
         self._log_filehandler = None
         self._version = None  # cached version
         self._local = local
@@ -967,12 +978,18 @@ def nplot(self, nnum="", vtk=None, **kwargs):
         >>> mapdl.nplot(vtk=False)
 
         """
-        # lazy import here to avoid top level import
-        import pyvista as pv
-
         if vtk is None:
             vtk = self._use_vtk
 
+        if vtk is True:
+            if _HAS_PYVISTA:
+                # lazy import here to avoid top level import
+                import pyvista as pv
+            else:  # pragma: no cover
+                raise ModuleNotFoundError(
+                    f"Using the keyword argument 'vtk' requires having Pyvista installed."
+                )
+
         if "knum" in kwargs:
             raise ValueError("`knum` keyword deprecated.  Please use `nnum` instead.")
 
@@ -1000,6 +1017,81 @@ def nplot(self, nnum="", vtk=None, **kwargs):
         self._enable_interactive_plotting()
         return super().nplot(nnum, **kwargs)
 
+    def eplot(self, show_node_numbering=False, vtk=None, **kwargs):
+        """Plots the currently selected elements.
+
+        APDL Command: EPLOT
+
+        .. note::
+            PyMAPDL plotting commands with ``vtk=True`` ignore any
+            values set with the ``PNUM`` command.
+
+        Parameters
+        ----------
+        vtk : bool, optional
+            Plot the currently selected elements using ``pyvista``.
+            Defaults to current ``use_vtk`` setting.
+
+        show_node_numbering : bool, optional
+            Plot the node numbers of surface nodes.
+
+        **kwargs
+            See ``help(ansys.mapdl.core.plotter.general_plotter)`` for more
+            keyword arguments related to visualizing using ``vtk``.
+
+        Examples
+        --------
+        >>> mapdl.clear()
+        >>> mapdl.prep7()
+        >>> mapdl.block(0, 1, 0, 1, 0, 1)
+        >>> mapdl.et(1, 186)
+        >>> mapdl.esize(0.1)
+        >>> mapdl.vmesh('ALL')
+        >>> mapdl.vgen(2, 'all')
+        >>> mapdl.eplot(show_edges=True, smooth_shading=True,
+                        show_node_numbering=True)
+
+        Save a screenshot to disk without showing the plot
+
+        >>> mapdl.eplot(background='w', show_edges=True, smooth_shading=True,
+                        window_size=[1920, 1080], savefig='screenshot.png',
+                        off_screen=True)
+
+        """
+        if vtk is None:
+            vtk = self._use_vtk
+        elif vtk is True:
+            if not _HAS_PYVISTA:  # pragma: no cover
+                raise ModuleNotFoundError(
+                    f"Using the keyword argument 'vtk' requires having Pyvista installed."
+                )
+
+        if vtk:
+            kwargs.setdefault("title", "MAPDL Element Plot")
+            if not self._mesh.n_elem:
+                warnings.warn("There are no elements to plot.")
+                return general_plotter([], [], [], **kwargs)
+
+            # TODO: Consider caching the surface
+            esurf = self.mesh._grid.linear_copy().extract_surface().clean()
+            kwargs.setdefault("show_edges", True)
+
+            # if show_node_numbering:
+            labels = []
+            if show_node_numbering:
+                labels = [{"points": esurf.points, "labels": esurf["ansys_node_num"]}]
+
+            return general_plotter(
+                [{"mesh": esurf, "style": kwargs.pop("style", "surface")}],
+                [],
+                labels,
+                **kwargs,
+            )
+
+        # otherwise, use MAPDL plotter
+        self._enable_interactive_plotting()
+        return self.run("EPLOT")
+
     def vplot(
         self,
         nv1="",
@@ -1064,6 +1156,11 @@ def vplot(
         """
         if vtk is None:
             vtk = self._use_vtk
+        elif vtk is True:
+            if not _HAS_PYVISTA:  # pragma: no cover
+                raise ModuleNotFoundError(
+                    f"Using the keyword argument 'vtk' requires having Pyvista installed."
+                )
 
         if vtk:
             kwargs.setdefault("title", "MAPDL Volume Plot")
@@ -1185,6 +1282,11 @@ def aplot(
         """
         if vtk is None:
             vtk = self._use_vtk
+        elif vtk is True:
+            if not _HAS_PYVISTA:  # pragma: no cover
+                raise ModuleNotFoundError(
+                    f"Using the keyword argument 'vtk' requires having Pyvista installed."
+                )
 
         if vtk:
             kwargs.setdefault("show_scalar_bar", False)
@@ -1380,6 +1482,11 @@ def lplot(
         """
         if vtk is None:
             vtk = self._use_vtk
+        elif vtk is True:
+            if not _HAS_PYVISTA:  # pragma: no cover
+                raise ModuleNotFoundError(
+                    f"Using the keyword argument 'vtk' requires having Pyvista installed."
+                )
 
         if vtk:
             kwargs.setdefault("show_scalar_bar", False)
@@ -1458,6 +1565,11 @@ def kplot(
         """
         if vtk is None:
             vtk = self._use_vtk
+        elif vtk is True:
+            if not _HAS_PYVISTA:  # pragma: no cover
+                raise ModuleNotFoundError(
+                    f"Using the keyword argument 'vtk' requires having Pyvista installed."
+                )
 
         if vtk:
             kwargs.setdefault("title", "MAPDL Keypoint Plot")
@@ -2342,7 +2454,8 @@ def run(self, command, write_to_log=True, mute=None, **kwargs) -> str:
                 # Edge case. `\title, 'par=1234' `
                 self._check_parameter_name(param_name)
 
-        text = self._run(command, mute=mute, **kwargs)
+        verbose = kwargs.get("verbose", False)
+        text = self._run(command, verbose=verbose, mute=mute)
 
         if mute:
             return

src/ansys/mapdl/core/misc.py

@@ -64,10 +64,8 @@ def __init__(self, additional=None, ncol=3, text_width=80, sort=False, gpu=True)
         core = [
             "matplotlib",
             "numpy",
-            "pyvista",
             "appdirs",
             "tqdm",
-            "pyiges",
             "scipy",
             "grpc",  # grpcio
             "ansys.api.mapdl.v0",  # ansys-api-mapdl-v0
@@ -79,7 +77,7 @@ def __init__(self, additional=None, ncol=3, text_width=80, sort=False, gpu=True)
             core.extend(["pexpect"])
 
         # Optional packages
-        optional = ["matplotlib"]
+        optional = ["matplotlib", "pyvista", "pyiges"]
         if sys.version_info[1] < 9:
             optional.append("ansys_corba")
 

src/ansys/mapdl/core/plotting.py

@@ -1,6 +1,5 @@
 """Plotting helper for MAPDL using pyvista"""
 import numpy as np
-import pyvista as pv
 
 from ansys.mapdl.core.misc import unique_rows
 
@@ -212,6 +211,9 @@ def general_plotter(
                     off_screen=True)
 
     """
+    # Lazy import
+    import pyvista as pv
+
     if notebook:
         off_screen = True