Merge branch 'master' into mhanmer/operator_doc_template

Author: ansMHanmer

.ci/build_wheel.py

@@ -2,14 +2,13 @@
 # Input can be one of ["any", "win", "manylinux1", "manylinux_2_17"]
 
 import argparse
-import subprocess
-from pathlib import Path
 import os
-import sys
+from pathlib import Path
 import shutil
+import subprocess
+import sys
 import tempfile
 
-
 supported_platforms = {
     "any": "any",
     "win": "win_amd64",

.ci/code_generation.py

@@ -1,12 +1,12 @@
 # import subprocess
 
-from ansys.dpf import core
-from ansys.dpf.core.operators import build
-import os
 import glob
+import os
 from pathlib import Path
 import shutil
 
+from ansys.dpf import core
+from ansys.dpf.core.operators import build
 
 local_dir = Path(__file__).parent
 TARGET_PATH = local_dir.parent / "src" / "ansys" / "dpf" / "core" / "operators"

.ci/run_examples.py

@@ -1,13 +1,12 @@
-import os
 import glob
+import os
 from pathlib import Path
 import subprocess
 import sys
 
 import ansys.dpf.core as dpf
 from ansys.dpf.core.examples import get_example_required_minimum_dpf_version
 
-
 os.environ["PYVISTA_OFF_SCREEN"] = "true"
 os.environ["MPLBACKEND"] = "Agg"
 

.ci/run_non_regression_examples.py

@@ -1,10 +1,11 @@
-import os
 import glob
-from ansys.dpf import core
+import os
 import pathlib
 import subprocess
 import sys
 
+from ansys.dpf import core
+
 os.environ["PYVISTA_OFF_SCREEN"] = "true"
 os.environ["MPLBACKEND"] = "Agg"
 

.ci/update_dpf_dependencies.py

@@ -13,14 +13,13 @@
 or the repo defined by the environment variable "ANSYSDPFCORE_ROOT" if it exists.
 """
 
-import os
 import glob
+import os
 from pathlib import Path
 import platform
 import shutil
 import zipfile
 
-
 grpc_path_key = "DPFDV_ROOT"
 gate_path_key = "ANSYSDPFPYGATE_ROOT"
 core_path = Path(__file__).parent.parent

.github/workflows/ci_release.yml

@@ -15,7 +15,7 @@ on:
       standalone_branch_suffix:
         description: 'Suffix of the branch on standalone'
         required: false
-        default: '.pre0'
+        default: ''
 
 #┌───────────── minute (0 - 59)
 #│ ┌───────────── hour (0 - 23)
@@ -80,7 +80,7 @@ jobs:
       python_versions: '["3.9"]'
       wheel: true
       wheelhouse: true
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
     secrets: inherit
 
   tests:
@@ -91,7 +91,7 @@ jobs:
       DOCSTRING: false
       wheel: false
       wheelhouse: true
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
     secrets: inherit
 
   tests_any_3_9:
@@ -101,7 +101,7 @@ jobs:
       python_versions: '["3.9"]'
       wheel: true
       wheelhouse: false
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
       test_any: true
     secrets: inherit
 
@@ -113,15 +113,15 @@ jobs:
       DOCSTRING: false
       wheel: false
       wheelhouse: false
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
       test_any: true
     secrets: inherit
 
   docs:
     uses: ./.github/workflows/docs.yml
     with:
       ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
       event_name: ${{ github.event_name }}
     secrets: inherit
 
@@ -130,7 +130,7 @@ jobs:
     with:
       ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
       python_versions: '["3.9", "3.10", "3.11"]'
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
     secrets: inherit
 
   retro_242:
@@ -184,7 +184,7 @@ jobs:
     uses: ./.github/workflows/pydpf-post.yml
     with:
       ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
       test_docstrings: "true"
     secrets: inherit
 
@@ -228,7 +228,7 @@ jobs:
     uses: ./.github/workflows/test_docker.yml
     with:
       ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
     secrets: inherit
 
   docker_examples:
@@ -237,7 +237,7 @@ jobs:
     with:
       ANSYS_VERSION: ${{ github.event.inputs.ansys_version || '251' }}
       python_versions: '["3.9", "3.10", "3.11"]'
-      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '.pre0' }}
+      standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
     secrets: inherit
 
   draft_release:

.github/workflows/docs.yml

@@ -73,34 +73,16 @@ jobs:
         with:
           python-version: ${{ inputs.python_version }}
 
-      - name: "Create virtual environment in the current workspace"
-        shell: pwsh
-        run: python -m venv .venv --system-site-packages
-      
-      - name: "Update PATH for virtual environment"
-        run: |
-          echo "${{ github.workspace }}\.venv\Scripts" >> $env:GITHUB_PATH
-
-      - name: "Update pip to the latest version"
+      - name: "Update pip to the latest version and install tox"
         shell: pwsh
         run: |
           python -m pip install -U pip
-
-      - name: "Install requirements"
-        shell: pwsh
-        run: |
-          python -m pip install -r requirements/requirements_build.txt
+          python -m pip install tox tox-uv
 
       - name: "Build the wheel"
         shell: pwsh
         run: |
-          $os = "${{ matrix.os }}"
-          if ($os -eq "ubuntu-latest") {
-              $platform = "manylinux_2_17"
-          } else {
-              $platform = "win"
-          }
-          python .ci/build_wheel.py -p $platform -w
+          tox -e build-wheel
 
       - name: "Expose the wheel"
         shell: bash
@@ -111,11 +93,6 @@ jobs:
           echo ${name}
           echo "wheel_name=${name[0]}" >> $GITHUB_OUTPUT
 
-      - name: "Install package wheel"
-        shell: pwsh
-        run: |
-          python -m pip install dist/${{ steps.wheel.outputs.wheel_name }}[plotting]
-
       - name: "Install DPF"
         id: set-server-path
         uses: ansys/pydpf-actions/[email protected]
@@ -128,9 +105,9 @@ jobs:
         uses: ansys/pydpf-actions/[email protected]
 
       - name: "Test import"
-        shell: pwsh
-        working-directory: tests
+        shell: bash
         run: |
+          python -m pip install dist/${{ steps.wheel.outputs.wheel_name }}
           python -c "from ansys.dpf import core"
 
       - name: "Setup headless display"
@@ -143,53 +120,10 @@ jobs:
         run: |
           choco install pandoc
 
-      - name: "Install documentation packages for Python"
-        shell: pwsh
-        run: |
-          python -m pip install -r requirements/requirements_docs.txt
-
-      - name: "Kill all servers"
-        uses: ansys/pydpf-actions/[email protected]
-
-      - name: "Ensure VTK compatibility"
-        shell: pwsh
-        run: |
-          python -m pip uninstall --yes vtk
-          python -m pip install --extra-index-url https://wheels.vtk.org vtk-osmesa==${{ env.VTK_OSMESA_VERSION }}
-
-      - name: "List installed packages"
-        shell: pwsh
-        run: |
-          python -m pip list
-
       - name: "Build HTML Documentation"
-        shell: cmd /D /E:ON /V:OFF /C "CALL "{0}""
-        working-directory: .ci
-        run: |
-          build_doc.bat > ..\doc\log.txt && type ..\doc\log.txt 2>&1
-        timeout-minutes: 60
-        env:
-          MEILISEARCH_PUBLIC_API_KEY: ${{ secrets.MEILISEARCH_PUBLIC_API_KEY }}
-
-      - name: "Check for success"
         shell: bash
-        working-directory: doc
         run: |
-          case `grep -F "build succeeded" log.txt >/dev/null; echo $?` in
-          0)
-            echo "Build succeeded!"
-            exit 0;;
-          1)
-            echo "Documentation generation failed, please check previous step!"
-            exit 1;;
-          *)
-            echo "An error occurred while checking success of the previous step!"
-            exit 1;;
-          esac
-
-      - name: "Kill all servers"
-        uses: ansys/pydpf-actions/[email protected]
-        if: always()
+          tox -e doc-html --installpkg dist/${{ steps.wheel.outputs.wheel_name }} -x testenv:doc-html.setenv+='VIRTUALENV_SYSTEM_SITE_PACKAGES=true'
 
       - name: "Retrieve package version"
         shell: bash