feat: separate graphics target (#1782)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: RobPasMue

.github/workflows/ci_cd.yml

@@ -91,7 +91,8 @@ jobs:
           library-name: ${{ env.PACKAGE_NAME }}
           operating-system: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
-          whitelist-license-check: 'attrs'
+          whitelist-license-check: 'attrs,referencing'
+          target: 'all'
 
   docker-style:
     name: Docker Style Check
@@ -545,9 +546,61 @@ jobs:
           docker logs ${{ env.GEO_CONT_NAME }}
           docker rm ${{ env.GEO_CONT_NAME }}
 
+  testing-no-graphics:
+    name: Testing with minimum requirements (no graphics)
+    needs: [smoke-tests]
+    runs-on: ubuntu-latest
+    env:
+      ANSRV_GEO_IMAGE_MINREQS: 'ghcr.io/ansys/geometry:core-linux-latest'
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.13']
+    steps:
+      - name: Login in Github Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pull and launch geometry service
+        run: |
+          docker pull ${{ env.ANSRV_GEO_IMAGE_MINREQS }}
+          docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_MINREQS }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install minimum requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[tests-minimal]
+          # Uninstall pytest-pyvista (not needed for these tests)
+          pip uninstall -y pytest-pyvista
+          # Installing docker (needed for the tests)
+          pip install docker
+
+      - name: Run pytest
+        run: |
+          pytest -v -c pytest-nographics.ini
+
+      - name: Stop the Geometry service
+        if: always()
+        run: |
+          docker stop ${{ env.GEO_CONT_NAME }}
+          docker logs ${{ env.GEO_CONT_NAME }}
+          docker rm ${{ env.GEO_CONT_NAME }}
+
+
   package:
     name: Package library
-    needs: [testing-windows, testing-linux, testing-min-reqs, docs]
+    needs: [testing-windows, testing-linux, testing-min-reqs, testing-no-graphics, docs]
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts

doc/changelog.d/1782.added.md

@@ -0,0 +1 @@
+separate graphics target

doc/source/assets.rst

@@ -25,7 +25,7 @@ For example, on Linux with Python 3.10, unzip the wheelhouse archive and install
 
 .. code:: bash
 
-    unzip ansys-geometry-core-v0.10.dev0-wheelhouse-ubuntu-latest-3.10.zip wheelhouse
+    unzip ansys-geometry-core-v0.10.dev0-all-wheelhouse-ubuntu-latest-3.10.zip wheelhouse
     pip install ansys-geometry-core -f wheelhouse --no-index --upgrade --ignore-installed
 
 If you are on Windows with Python 3.10, unzip to a wheelhouse directory by running ``-d wheelhouse``
@@ -43,7 +43,7 @@ The following wheelhouse files are available for download:
     {{ "^" * os_name|length }}
 
     {%- for link in download_links %}
-    * `{{ link.os }} wheelhouse for Python {{ link.python_versions }} <{{ link.prefix_url }}/ansys-geometry-core-{{ link.latest_released_version }}-wheelhouse-{{ link.runner }}-{{ link.python_versions }}.zip>`_
+    * `{{ link.os }} wheelhouse for Python {{ link.python_versions }} <{{ link.prefix_url }}/ansys-geometry-core-{{ link.latest_released_version }}-all-wheelhouse-{{ link.runner }}-{{ link.python_versions }}.zip>`_
     {%- endfor %}
 
     {%- endfor %}

doc/source/getting_started/installation.rst

@@ -94,7 +94,7 @@ For example, on Linux with Python 3.10, unzip the wheelhouse archive and install
 
 .. code:: bash
 
-    unzip ansys-geometry-core-v0.10.dev0-wheelhouse-ubuntu-3.10.zip wheelhouse
+    unzip ansys-geometry-core-v0.10.dev0-all-wheelhouse-ubuntu-3.10.zip wheelhouse
     pip install ansys-geometry-core -f wheelhouse --no-index --upgrade --ignore-installed
 
 If you are on Windows with Python 3.10, unzip the wheelhouse archive to a wheelhouse directory

pyproject.toml

@@ -26,29 +26,35 @@ classifiers = [
 dependencies = [
     "ansys-api-geometry==0.4.42",
     "ansys-tools-path>=0.3,<1",
-    "ansys-tools-visualization-interface>=0.2.6,<1",
     "attrs!=24.3.0",
     "beartype>=0.11.0,<0.20",
     "geomdl>=5,<6",
     "grpcio>=1.35.0,<1.68",
     "grpcio-health-checking>=1.45.0,<1.68",
+    "matplotlib>=3,<4",
     "numpy>=1.20.3,<3",
     "Pint>=0.18,<1",
     "protobuf>=3.20.2,<6",
-    "pygltflib>=1.16,<2",
-    "pyvista>=0.37.0,<1",
     "requests>=2,<3",
     "scipy>=1.7.3,<2",
     "semver>=3,<4",
     "six>=1.16.0,<2",
-    "vtk>=9,<10",
 ]
 
 [project.optional-dependencies]
+graphics = [
+    "ansys-tools-visualization-interface>=0.2.6,<1",
+    "pygltflib>=1.16,<2",
+    "pyvista[jupyter]>=0.38.1,<1",
+    "vtk>=9,<10",
+]
 all = [
     "ansys-platform-instancemanagement>=1.0.3,<2",
+    "ansys-tools-visualization-interface>=0.2.6,<1",
     "docker>=6.0.1,<8",
+    "pygltflib>=1.16,<2",
     "pyvista[jupyter]>=0.38.1,<1",
+    "vtk>=9,<10",
 ]
 tests = [
     "ansys-platform-instancemanagement==1.1.2",
@@ -59,6 +65,7 @@ tests = [
     "geomdl==5.3.1",
     "grpcio==1.67.1",
     "grpcio-health-checking==1.67.1",
+    "matplotlib==3.10.0",
     "numpy==2.2.3",
     "Pint==0.24.4",
     "protobuf==5.29.3",
@@ -92,6 +99,7 @@ doc = [
     "ipyvtklink==0.2.3",
     "jupyter_sphinx==0.5.3",
     "jupytext==1.16.7",
+    "matplotlib==3.10.0",
     "myst-parser==4.0.1",
     "nbconvert==7.16.6",
     "nbsphinx==0.9.6",
@@ -101,6 +109,7 @@ doc = [
     "panel==1.6.1",
     "Pint==0.24.4",
     "protobuf==5.29.3",
+    "pygltflib==1.16.3",
     "pyvista[jupyter]==0.44.2",
     "requests==2.32.3",
     "scipy==1.15.2",

pytest-nographics.ini

@@ -0,0 +1,4 @@
+[pytest]
+minversion = 7.1
+addopts = -ra --cov=ansys.geometry --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv
+testpaths = ["tests"]

src/ansys/geometry/core/connection/conversions.py

@@ -56,6 +56,7 @@
 from ansys.geometry.core.math.plane import Plane
 from ansys.geometry.core.math.point import Point2D, Point3D
 from ansys.geometry.core.math.vector import UnitVector3D
+from ansys.geometry.core.misc.checks import graphics_required
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, UNITS
 from ansys.geometry.core.shapes.curves.circle import Circle
 from ansys.geometry.core.shapes.curves.curve import Curve
@@ -404,6 +405,7 @@ def sketch_segment_to_grpc_line(segment: SketchSegment, plane: Plane) -> GRPCLin
     )
 
 
+@graphics_required
 def tess_to_pd(tess: Tessellation) -> "PolyData":
     """Convert an ``ansys.api.geometry.Tessellation`` to ``pyvista.PolyData``."""
     # lazy imports here to improve initial load

src/ansys/geometry/core/designer/body.py

@@ -80,19 +80,20 @@
 from ansys.geometry.core.math.point import Point3D
 from ansys.geometry.core.math.vector import UnitVector3D
 from ansys.geometry.core.misc.auxiliary import (
+    DEFAULT_COLOR,
     convert_color_to_hex,
     get_design_from_body,
 )
 from ansys.geometry.core.misc.checks import (
     check_type,
     check_type_all_elements_in_iterable,
     ensure_design_is_active,
+    graphics_required,
     min_backend_version,
 )
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Angle, Distance
 from ansys.geometry.core.sketch.sketch import Sketch
 from ansys.geometry.core.typing import Real
-from ansys.tools.visualization_interface.utils.color import Color
 
 if TYPE_CHECKING:  # pragma: no cover
     from pyvista import MultiBlock, PolyData
@@ -865,7 +866,7 @@ def color(self) -> str:  # noqa: D102
         """Get the current color of the body."""
         if self._color is None and self.is_alive:
             # Assigning default value first
-            self._color = Color.DEFAULT.value
+            self._color = DEFAULT_COLOR
 
             if self._grpc_client.backend_version < (25, 1, 0):  # pragma: no cover
                 # Server does not support color retrieval before version 25.1.0
@@ -1209,6 +1210,7 @@ def copy(self, parent: "Component", name: str = None) -> "Body":  # noqa: D102
         return Body(body_id, response.name, parent, tb)
 
     @protect_grpc
+    @graphics_required
     def tessellate(  # noqa: D102
         self, merge: bool = False, transform: Matrix44 = IDENTITY_MATRIX44
     ) -> Union["PolyData", "MultiBlock"]:
@@ -1724,6 +1726,7 @@ def shell_body(self, offset: Real) -> bool:  # noqa: D102
     def remove_faces(self, selection: Face | Iterable[Face], offset: Real) -> bool:  # noqa: D102
         return self._template.remove_faces(selection, offset)
 
+    @graphics_required
     def plot(  # noqa: D102
         self,
         merge: bool = True,

src/ansys/geometry/core/designer/component.py

@@ -75,7 +75,11 @@
 from ansys.geometry.core.math.matrix import Matrix44
 from ansys.geometry.core.math.point import Point3D
 from ansys.geometry.core.math.vector import UnitVector3D, Vector3D
-from ansys.geometry.core.misc.checks import ensure_design_is_active, min_backend_version
+from ansys.geometry.core.misc.checks import (
+    ensure_design_is_active,
+    graphics_required,
+    min_backend_version,
+)
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Angle, Distance
 from ansys.geometry.core.shapes.curves.circle import Circle
 from ansys.geometry.core.shapes.curves.trimmed_curve import TrimmedCurve
@@ -1448,6 +1452,7 @@ def _kill_component_on_client(self) -> None:
         # Kill itself
         self._is_alive = False
 
+    @graphics_required
     def tessellate(self, _recursive_call: bool = False) -> Union["PolyData", list["MultiBlock"]]:
         """Tessellate the component.
 
@@ -1485,6 +1490,7 @@ def tessellate(self, _recursive_call: bool = False) -> Union["PolyData", list["M
             ugrid = pv.MultiBlock(datasets).combine()
             return pv.PolyData(var_inp=ugrid.points, faces=ugrid.cells)
 
+    @graphics_required
     def plot(
         self,
         merge_component: bool = True,

src/ansys/geometry/core/designer/designpoint.py

@@ -24,7 +24,7 @@
 from typing import TYPE_CHECKING
 
 from ansys.geometry.core.math.point import Point3D
-from ansys.geometry.core.misc.checks import check_type
+from ansys.geometry.core.misc.checks import check_type, graphics_required
 from ansys.geometry.core.misc.units import UNITS
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -89,6 +89,7 @@ def __repr__(self) -> str:
         lines.append(f"  Design Point         : {self.value}")
         return "\n".join(lines)
 
+    @graphics_required
     def _to_polydata(self) -> "pv.PolyData":
         """Get polydata from DesignPoint object."""
         import pyvista as pv