Merge branch 'main' into release/2024.1

Author: RobPasMue

.github/workflows/ci-build.yml

@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/doc-style@v4
+        uses: ansys/actions/doc-style@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -48,13 +48,13 @@ jobs:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
@@ -75,14 +75,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
         extras-version: ['fluent-all', 'mapdl-all', 'tools']
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
@@ -103,11 +103,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@v4
+        uses: ansys/actions/build-wheelhouse@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           operating-system: ${{ runner.os }}
@@ -120,7 +120,7 @@ jobs:
           cat all-deps-${{ runner.os }}-${{ matrix.python-version }}.txt
 
       - name: Upload dependencies list
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: all-deps-${{ runner.os }}-${{ matrix.python-version }}
           path: all-deps-${{ runner.os }}-${{ matrix.python-version }}.txt
@@ -133,24 +133,39 @@ jobs:
 
     steps:
       - name: Build documentation
-        uses: ansys/actions/doc-build@v4
+        uses: ansys/actions/doc-build@v5
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           dependencies: "build-essential zip pandoc texlive-latex-extra latexmk texlive-pstricks"
 
-      - name: Deploy the dev documentation
-        uses: ansys/actions/doc-deploy-dev@v4
-        if: github.ref == 'refs/heads/main'
-        with:
-          cname: ${{ env.DOCUMENTATION_CNAME }}
-          token: ${{ secrets.GITHUB_TOKEN }}
-
+  doc-deploy-dev:
+      name: "Deploy development docs"
+      if: github.ref == 'refs/heads/main'
+      runs-on: ubuntu-latest
+      needs: [package]
+      steps:
+        - name: Deploy the latest documentation
+          uses: ansys/actions/doc-deploy-dev@v5
+          with:
+            cname: ${{ env.DOCUMENTATION_CNAME }}
+            token: ${{ secrets.GITHUB_TOKEN }}
+
+  adapt-landing-page-dev:
+    uses: ./.github/workflows/update-gh-pages.yml
+    needs: [doc-deploy-dev]
+    secrets: inherit
+
+  doc-index-dev:
+    name: "Deploy dev docs index"
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: [doc-deploy-dev]
+    steps:
       - name: "Deploy the dev documentation index"
-        uses: ansys/actions/doc-deploy-index@v4
-        if: github.ref == 'refs/heads/main'
+        uses: ansys/actions/doc-deploy-index@v5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}/version/dev
-          index-name: "pyansys-vdev"
+          index-name: pyansys-vdev
           host-url: ${{ vars.MEILISEARCH_HOST_URL }}
           api-key: ${{ env.MEILISEARCH_API_KEY }}
 
@@ -160,7 +175,7 @@ jobs:
     needs: [docs-build, smoke-tests-core]
     steps:
       - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@v4
+        uses: ansys/actions/build-library@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -172,29 +187,34 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to PyPI repository
-        uses: ansys/actions/release-pypi-public@v4
+        uses: ansys/actions/release-pypi-public@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: __token__
           twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: Release to GitHub
-        uses: ansys/actions/release-github@v4
+        uses: ansys/actions/release-github@v5
         with:
           library-name: ${{ env.PACKAGE_NAME }}
-          additional-artifacts: 'all-deps-Linux-3.8 all-deps-Linux-3.9 all-deps-Linux-3.10 all-deps-Linux-3.11 all-deps-Windows-3.8 all-deps-Windows-3.9 all-deps-Windows-3.10 all-deps-Windows-3.11 all-deps-macOS-3.8 all-deps-macOS-3.9 all-deps-macOS-3.10 all-deps-macOS-3.11'
+          additional-artifacts: 'all-deps-Linux-3.9 all-deps-Linux-3.10 all-deps-Linux-3.11 all-deps-Linux-3.12 all-deps-Windows-3.9 all-deps-Windows-3.10 all-deps-Windows-3.11 all-deps-Windows-3.12 all-deps-macOS-3.9 all-deps-macOS-3.10 all-deps-macOS-3.11 all-deps-macOS-3.12'
 
   docs-release:
     name: Deploy release docs
     runs-on: ubuntu-latest
     needs: [release]
     steps:
       - name: Deploy the latest release documentation
-        uses: ansys/actions/doc-deploy-stable@v4
+        uses: ansys/actions/doc-deploy-stable@v5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
+  adapt-landing-page-release:
+    uses: ./.github/workflows/update-gh-pages.yml
+    needs: [docs-release]
+    secrets: inherit
+
   doc-index-release:
     name: "Deploy release docs index"
     runs-on: ubuntu-latest
@@ -218,7 +238,7 @@ jobs:
           echo "VERSION_MEILI=$VERSION_MEILI" >> $GITHUB_ENV
 
       - name: "Deploy the latest documentation index"
-        uses: ansys/actions/doc-deploy-index@v4
+        uses: ansys/actions/doc-deploy-index@v5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}/version/${{ env.VERSION }}
           index-name: pyansys-v${{ env.VERSION_MEILI }}

.github/workflows/create-milestone.yml

@@ -19,29 +19,31 @@ jobs:
       matrix:
         pyansys-projects:
           [
-            "ansys/pydpf-composites",
+            "ansys/pyadditive",
+            "ansys/pyaedt",
+            "ansys/pyansys-geometry",
+            "ansys/pyansys-math",
             "ansys/pydpf-core",
             "ansys/pydpf-post",
+            "ansys/pydpf-composites",
             "ansys/pydyna",
             "ansys/pydynamicreporting",
-            "ansys/pyansys-geometry",
-            "ansys/grantami-bomanalytics",
-            "ansys/grantami-recordlists",
+            "ansys/pyensight",
             "ansys/pyfluent",
             "ansys/pymapdl",
-            "ansys/pyansys-math",
             "ansys/pymechanical",
-            "ansys/pyprimemesh",
             "ansys/pymotorcad",
-            "ansys/pypim",
-            "ansys/pyensight",
-            "ansys/openapi-common",
             "ansys/pyoptislang",
+            "ansys/pypim",
+            "ansys/pyprimemesh",
             "ansys/pyseascape",
             "ansys/pysherlock",
             "ansys/pysystem-coupling",
-            "ansys/pyaedt",
+            "ansys/pyturbogrid",
             "ansys/pytwin",
+            "ansys/grantami-bomanalytics",
+            "ansys/grantami-recordlists",
+            "ansys/openapi-common",
             # MAPDL - ALL
             "ansys/pymapdl-reader",
             # FLUENT - ALL
@@ -58,7 +60,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 

.github/workflows/update-gh-pages.yml

@@ -0,0 +1,26 @@
+
+name: Update index.html in GH Pages
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  update-gh-pages:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        ref: gh-pages
+
+    - name: Replace 'version/stable' with 'version/dev' in index.html
+      run: |
+        sed -i 's/version\/stable/version\/dev/g' index.html
+
+    - name: "Commit changes"
+      uses: EndBug/add-and-commit@v9
+      with:
+        default_author: github_actions
+        message: "update index.html"

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 23.9.1
+  rev: 23.12.1
   hooks:
   - id: black
 
 - repo: https://github.com/pycqa/isort
-  rev: 5.12.0
+  rev: 5.13.2
   hooks:
   - id: isort
 
@@ -16,7 +16,7 @@ repos:
   - id: flake8
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.5
+  rev: v2.2.6
   hooks:
   - id: codespell
     args: ["--ignore-words=ignore_words.txt"]
@@ -29,7 +29,7 @@ repos:
     exclude: "tests/"
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v4.5.0
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
@@ -38,6 +38,6 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.26.3
+  rev: 0.27.3
   hooks:
     - id: check-github-workflows

README.rst

@@ -36,6 +36,7 @@ of these packages amongst themselves and the Ansys product release that they are
 
 The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages:
 
+- `PyAdditive <https://additive.docs.pyansys.com/>`_: Pythonic interface to the Ansys Additive service.
 - `PyAEDT <https://aedt.docs.pyansys.com/>`_: Pythonic interface to AEDT (Ansys Electronics Desktop).
 - `PyAnsys Geometry <https://geometry.docs.pyansys.com/>`_: Pythonic interface to the Ansys Geometry service.
 - `PyAnsys Math <https://math.docs.pyansys.com/>`_: Pythonic interface to PyAnsys Math libraries.
@@ -58,6 +59,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 - `PySeascape <https://seascape.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys RedHawkSC and TotemSC.
 - `PySherlock <https://sherlock.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys Sherlock.
 - `PySystemCoupling <https://systemcoupling.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys System Coupling.
+- `PyTurboGrid <https://turbogrid.docs.pyansys.com/>`_: Pythonic interface to Ansys TurboGrid, a high-quality turbomachinery meshing software app.
 - `PyTwin <https://twin.docs.pyansys.com/>`_: Pythonic interface to communicate with consumption workflows for Ansys digital twins.
 - `Granta MI BoM Analytics <https://bomanalytics.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI BoM Analytics services.
 - `Granta MI RecordLists <https://recordlists.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI Lists API.
@@ -78,6 +80,7 @@ free to post a question on the `Ansys Developer Forums <https://discuss.ansys.co
 
 By default, the PyAnsys metapackage installs these core modules:
 
+- `PyAdditive`_
 - `PyAEDT`_
 - `PyAnsys Geometry`_
 - `PyAnsys Math`_
@@ -97,6 +100,7 @@ By default, the PyAnsys metapackage installs these core modules:
 - `PySeascape`_
 - `PySherlock`_
 - `PySystemCoupling`_
+- `PyTurboGrid`_
 - `PyTwin`_
 - `Granta MI BoM Analytics`_
 - `Granta MI RecordLists`_
@@ -153,15 +157,15 @@ the ``pyansys`` metapackage is downloading the wheelhouse archive from the
 `Releases Page <https://github.com/ansys/pyansys/releases>`_ for your corresponding machine architecture.
 
 Each wheelhouse archive contains all the Python wheels necessary to install the ``pyansys`` metapackage from
-scratch on Windows, Linux, and MacOS from Python 3.8 to 3.11. You can install this on an isolated system with
+scratch on Windows, Linux, and MacOS from Python 3.9 to 3.11. You can install this on an isolated system with
 a fresh Python installation or on a virtual environment.
 
-For example, on Linux with Python 3.8, unzip the wheelhouse archive and install it with the following
+For example, on Linux with Python 3.9, unzip the wheelhouse archive and install it with the following
 commands:
 
 .. code:: bash
 
-    unzip pyansys-v2024.1rc1-wheelhouse-Linux-3.8-core.zip wheelhouse
+    unzip pyansys-v2024.1rc1-wheelhouse-Linux-3.9-core.zip wheelhouse
     pip install pyansys -f wheelhouse --no-index --upgrade --ignore-installed
 
 If you're on Windows with Python 3.9, unzip to a wheelhouse directory and then install using