feat: separate graphics target

.github/workflows/ci.yml

@@ -10,6 +10,7 @@ env:
   PYMAPDL_START_INSTANCE: FALSE
   DOCKER_PACKAGE: ghcr.io/pyansys/pymapdl/mapdl
   DOCUMENTATION_CNAME: reader.docs.pyansys.com
+  MAIN_PYTHON_VERSION: "3.11"
 
 on:
   pull_request:
@@ -24,42 +25,13 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  doc_build:
-    name: Build documentation
-    runs-on: ubuntu-latest
-    steps:
-      - name: Setup headless display
-        uses: pyvista/setup-headless-display-action@v3
-
-      - name: Build project documentation
-        uses: ansys/actions/doc-build@v8
-        with:
-          dependencies: 'pandoc'
-          skip-dependencies-cache: true
-          use-python-cache: false
-          python-version: "3.10"
-          sphinxopts: "-j auto"
-
-  doc-deploy-dev:
-    name: Upload development documentation
-    runs-on: ubuntu-latest
-    needs: [doc_build]
-    if: github.ref == 'refs/heads/main'
-    steps:
-      - uses: ansys/actions/doc-deploy-dev@v8
-        with:
-          cname: ${{ env.DOCUMENTATION_CNAME }}
-          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
-          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
-          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
-
-  build:
-    name: Build and Test
+  smoke-tests:
+    name: Build wheels and smoke tests
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12']
         os: [ubuntu-latest, windows-latest]
 
     steps:
@@ -70,7 +42,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
-          cache-dependency-path: 'requirements/*.txt'
 
       - name: Build ManyLinux wheel
         if: ${{ runner.os == 'Linux' }}
@@ -105,23 +76,15 @@ jobs:
           pip install (get-item .\dist\*.whl)
           pip list
 
-      - name: Setup headless display
-        uses: pyvista/setup-headless-display-action@v3
-
-      - name: Install test requirements
-        run: pip install -r requirements/requirements_test.txt
-
-      - name: Test
-        run: pytest -v tests/ --durations=0
-
       - name: Upload wheel
         uses: actions/upload-artifact@v4
         with:
           name: ${{ env.PACKAGE_NAME }}-${{ runner.os }}-${{ matrix.python-version }}
           path: dist/
           retention-days: 7
 
-  mac_build:
+
+  smoke-tests-mac:
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
     name: Build wheels on MacOS
     runs-on: macos-latest
@@ -140,10 +103,105 @@ jobs:
         with:
           path: ./wheelhouse/*.whl
 
+
+  doc_build:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Install Git and checkout project"
+        uses: actions/[email protected]
+
+      - name: "Setup Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: "Install OS packages"
+        run: |
+          sudo apt update
+          sudo apt install pandoc
+
+      - name: "Install ansys-mapdl-reader and doc dependencies"
+        run: |
+          pip install .[doc]
+
+      - name: Setup headless display
+        uses: pyvista/setup-headless-display-action@v3
+
+      - name: Build project documentation
+        uses: ansys/actions/doc-build@v8
+        with:
+          dependencies: 'pandoc'
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          skip-install: true
+          checkout: false
+          sphinxopts: "-j auto"
+          use-python-cache: false
+
+
+  testing:
+    name: Testing
+    runs-on: ${{ matrix.os }}
+    needs: [smoke-tests]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          # cache: 'pip'
+
+      - name: Setup headless display
+        uses: pyvista/setup-headless-display-action@v3
+
+      - name: Install test requirements
+        run: pip install -e .[tests]
+
+      - name: Test
+        run: pytest -v tests/ --durations=0
+
+
+  testing-no-graphics:
+    name: Testing with minimum requirements (no graphics)
+    needs: [smoke-tests]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          # cache: 'pip'
+
+      - name: Setup headless display
+        uses: pyvista/setup-headless-display-action@v3
+
+      - name: Install minimal test requirements
+        run: |
+          pip install -e .[tests-minimal]
+
+      - name: Test
+        run: pytest -v tests/ --durations=0
+
+
   automerge-prs:
     name: Automerge PRs (dependabot and pre-commit.ci only)
     runs-on: ubuntu-latest
-    needs: [build, doc_build]
+    needs: [testing, testing-no-graphics, doc_build]
     if: github.event_name == 'pull_request'
     permissions:
       contents: write
@@ -155,89 +213,10 @@ jobs:
           approver: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
           approver-token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
 
-  # pymapdl_tests:
-  #   name: PyMAPDL Unit Testing
-  #   runs-on: ubuntu-latest
-  #   needs: build
-  #   strategy:
-  #     matrix:
-  #       mapdl-version: ['v21.1.1', 'v21.2.1', 'v22.1.0']
-
-  #   steps:
-
-  #     - name: Checkout PyMAPDL
-  #       uses: actions/checkout@v4
-  #       with:
-  #         repository: 'pyansys/pymapdl' #checking out main. Not release
-
-  #     - name: Display structure of downloaded PyMAPDL files
-  #       run: ls -R
-
-  #     - name: Downloading artifacts
-  #       uses: actions/download-artifact@v4
-
-  #     - name: Display structure of downloaded artifact files
-  #       run: ls -R
-
-  #     - name: Setup Python
-  #       uses: actions/setup-python@v2
-  #       with:
-  #         python-version: 3.8
-
-  #     - name: Install OS packages
-  #       run: |
-  #         sudo apt update
-  #         sudo apt install libgl1-mesa-glx xvfb
-
-  #     - name: Linux pip cache
-  #       uses: actions/cache@v3
-  #       with:
-  #         path: ~/.cache/pip
-  #         key: Python-${{ runner.os }}-3.8-${{ hashFiles('setup.py') }}-${{ hashFiles('requirements_*.txt') }}
-  #         restore-keys: |
-  #           Python-${{ runner.os }}-3.8
-
-  #     - name: Test virtual framebuffer
-  #       run: |
-  #         pip install -r .ci/requirements_test_xvfb.txt
-  #         xvfb-run python .ci/display_test.py
-
-  #     - name: Install ansys-mapdl-core
-  #       run: |
-  #         python -m pip install --upgrade pip
-  #         pip install .
-  #         xvfb-run python -c "from ansys.mapdl import core as pymapdl; print(pymapdl.Report())"
-
-  #     - name: Install ansys-mapdl-reader
-  #       run: |
-  #         pip install ansys-mapdl-reader-${{ runner.os }}-3.8/*.whl
-  #         xvfb-run python -c "from ansys.mapdl import reader as pymapdl_reader; print(pymapdl_reader); print('Installation and smoke test correct')"
-
-  #     - name: Login in Github Container registry
-  #       uses: docker/login-action@v1
-  #       with:
-  #         registry: ghcr.io
-  #         username: ${{ secrets.GH_USERNAME }}
-  #         password: ${{ secrets.GITHUB_TOKEN }}
-
-  #     - name: Pull, launch, and validate MAPDL service
-  #       run: .ci/start_mapdl.sh
-  #       env:
-  #         LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
-  #         MAPDL_IMAGE: ${{ env.DOCKER_PACKAGE }}:${{ matrix.mapdl-version }}
-
-  #     - name: Unit Testing
-  #       run: |
-  #         pip install -r requirements/requirements_tests.txt
-  #         xvfb-run pytest -v
-
-  #     - name: Display MAPDL Logs
-  #       if: always()
-  #       run: cat log.txt
-
-  Release:
+
+  release:
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: [doc_build, build, mac_build]
+    needs: [doc_build, smoke-tests-mac, testing, testing-no-graphics]
     runs-on: ubuntu-latest
     steps:
       - name: Set up Python
@@ -275,11 +254,12 @@ jobs:
             ./**/*.zip
             ./**/*.pdf
 
+
   doc-deploy-release:
     name: Upload release documentation
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
-    needs: [Release]
+    needs: [release]
     steps:
       - name: Deploy the stable documentation
         uses: ansys/actions/doc-deploy-stable@v8
@@ -288,3 +268,17 @@ jobs:
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
           bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
           bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+
+
+  doc-deploy-dev:
+    name: Upload development documentation
+    runs-on: ubuntu-latest
+    needs: [testing, testing-no-graphics, doc_build]
+    if: github.ref == 'refs/heads/main' && !contains(github.ref, 'refs/tags')
+    steps:
+      - uses: ansys/actions/doc-deploy-dev@v8
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

.gitignore

@@ -32,6 +32,7 @@ dist/
 
 # MISC
 _build/
+sg_execution_times.rst
 pyansys/Interface.py
 *.bat
 doc/source/examples/*

.pre-commit-config.yaml

@@ -24,12 +24,13 @@ repos:
   hooks:
   - id: codespell
 
-- repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.5.2
-  hooks:
-  - id: add-license-headers
-    args:
-    - --start_year=2021
+# need to be  enabled in another PR
+# - repo: https://github.com/ansys/pre-commit-hooks
+#   rev: v0.5.2
+#   hooks:
+#   - id: add-license-headers
+#     args:
+#     - --start_year=2021
 
 # add this eventually
 # - repo: https://github.com/pycqa/pydocstyle

ansys/mapdl/reader/__init__.py

@@ -2,14 +2,6 @@
 
 import appdirs
 
-# Per contract with Sphinx-Gallery, this method must be available at top level
-try:
-    # for pyvista >= 0.40
-    from pyvista.plotting.utilities import _get_sg_image_scraper
-except ImportError:
-    from pyvista.utilities.sphinx_gallery import _get_sg_image_scraper
-
-
 from ansys.mapdl.reader import examples
 from ansys.mapdl.reader._version import __version__
 from ansys.mapdl.reader.archive import (
@@ -20,7 +12,8 @@
 )
 from ansys.mapdl.reader.cell_quality import quality
 from ansys.mapdl.reader.common import read_binary
-from ansys.mapdl.reader.misc import Report, _configure_pyvista
+from ansys.mapdl.reader.misc.checks import run_if_graphics_required
+from ansys.mapdl.reader.misc.misc import Report, _configure_pyvista
 
 from . import _archive
 
@@ -29,5 +22,15 @@
 
 EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
 
-# set pyvista defaults
-_configure_pyvista()
+try:
+    run_if_graphics_required()
+    # set pyvista defaults
+    _configure_pyvista()
+    # Per contract with Sphinx-Gallery, this method must be available at top level
+    try:
+        # for pyvista >= 0.40
+        from pyvista.plotting.utilities import _get_sg_image_scraper
+    except ImportError:
+        from pyvista.utilities.sphinx_gallery import _get_sg_image_scraper
+except ImportError:
+    pass