Merge branch 'main' into ci/revert-temporary-doc-build-fix

Author: SMoraisAnsys

.github/labeler.yml

@@ -20,3 +20,9 @@ testing:
     - "tests/system/conftest.py"
     - "tests/system/solvers/conftest.py"
     - "tests/system/general/conftest.py"
+
+extensions:
+- changed-fles:
+  - any-glob-to-any-file:
+    - "src/ansys/aedt/core/extensions/**/*"
+    - "doc/source/Resources/pyaedt_installer_from_aedt.py"

.github/labels.yml

@@ -37,3 +37,7 @@
 - name: security
   description: Anything related to security advisories
   color: FF0000
+
+- name: extensions
+  description: Related to extensions
+  color: 6905d2

.github/workflows/ci_cd.yml

@@ -15,13 +15,17 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+permissions: {} # Disable default permissions
+
 jobs:
 
   label-syncer:
     name: Syncer
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
       - uses: micnncim/action-label-syncer@3abd5ab72fda571e69fffd97bd4e0033dd5f495c # v1.3.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -75,14 +79,22 @@ jobs:
       with:
         labels: testing
 
+    - uses: actions-ecosystem/action-add-labels@18f1af5e3544586314bbe15c0273249c770b2daf # v1.1.3
+      if: |
+        contains(github.event.pull_request.title, 'extension') ||
+        contains(github.event.pull_request.title, 'extensions')
+      with:
+        labels: extensions
+        
   commenter:
+    name: Suggest labels if none assigned
     runs-on: ubuntu-latest
     permissions:
       contents: read
       pull-requests: write
     steps:
     - name: Suggest to add labels
-      uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
+      uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
       # Execute only when no labels have been applied to the pull request
       if: toJSON(github.event.pull_request.labels.*.name) == '{}'
       with:
@@ -105,7 +117,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-    - uses: ansys/actions/doc-changelog@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+    - uses: ansys/actions/doc-changelog@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5
       with:
         token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
         use-conventional-commits: true

.github/workflows/label.yml

@@ -36,6 +36,8 @@ env:
   MAIN_PYTHON_VERSION: '3.10'
   PYTEST_ARGUMENTS: '-vvv --color=yes -ra --durations=25 --maxfail=10 --cov=ansys.aedt.core --cov-report=html --cov-report=xml --junitxml=junit/test-results.xml'
 
+permissions: {} # Disable default permissions
+  
 jobs:
 
   system-test-solvers-windows:
@@ -45,6 +47,8 @@ jobs:
     steps:
       - name: Install Git and checkout project
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
 
       - name: Setup Python
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
@@ -70,14 +74,25 @@ jobs:
           .venv\Scripts\Activate.ps1
           # Uninstall conflicting dependencies
           pip uninstall --yes vtk
-          pip install --extra-index-url https://wheels.vtk.org vtk-osmesa==9.3.1
+          pip install --index-url https://wheels.vtk.org vtk-osmesa==9.3.1
+
+      - name: Remove Ansys processes (if any)
+        shell: powershell
+        run: |
+          Get-Process | Where-Object {
+            $_.Path -like "*ansys inc*" -or $_.Path -like "*ansysem*"
+          } | ForEach-Object {
+            Write-Output "Killing $($_.Name) (PID: $($_.Id))"
+            Stop-Process -Id $_.Id -Force
+          }
 
       - name: Run tests marked with 'solvers'
         env:
           PYTHONMALLOC: malloc
+          PYTEST_ARGUMENTS: ${{ env.PYTEST_ARGUMENTS }}
         run: |
           .venv\Scripts\Activate.ps1
-          pytest ${{ env.PYTEST_ARGUMENTS }} -m solvers
+          pytest ${PYTEST_ARGUMENTS} -m solvers
 
       - uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
         with:
@@ -102,33 +117,50 @@ jobs:
     steps:  
       - name: Install Git and checkout project
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
 
       - name: Setup Python
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
       - name: Create virtual environment
+        env:
+          ANSYSEM: ${{ env.ANSYSEM_ROOT252 }}
         run: |
-          export LD_LIBRARY_PATH=${{ env.ANSYSEM_ROOT252 }}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
+          export LD_LIBRARY_PATH=${ANSYSEM}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
           python -m venv .venv
           source .venv/bin/activate
           python -m pip install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org pip -U
           python -m pip install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org wheel setuptools -U
           python -c "import sys; print(sys.executable)"
 
       - name: Install pyaedt and tests dependencies
+        env:
+          ANSYSEM: ${{ env.ANSYSEM_ROOT252 }}
         run: |
-          export LD_LIBRARY_PATH=${{ env.ANSYSEM_ROOT252 }}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
+          export LD_LIBRARY_PATH=${ANSYSEM}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
           source .venv/bin/activate
           pip install .[tests]
           pip install pytest-azurepipelines
 
+      - name: Remove Ansys processes (if any)
+        shell: bash
+        run: |
+          for pid in $(ps -eo pid,comm,args | grep -iE "ansys.inc|ansysem" | grep -v grep | awk '{print $1}'); do
+            echo "Killing PID $pid"
+            kill -9 "$pid"
+          done
+
       - name: Run tests marked with 'solvers'
+        env:
+          ANSYSEM: ${{ env.ANSYSEM_ROOT252 }}
+          PYTEST_ARGUMENTS: ${{ env.PYTEST_ARGUMENTS }}
         run: |
-          export LD_LIBRARY_PATH=${{ env.ANSYSEM_ROOT252 }}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
+          export LD_LIBRARY_PATH=${ANSYSEM}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
           source .venv/bin/activate
-          pytest ${{ env.PYTEST_ARGUMENTS }} -m solvers
+          pytest ${PYTEST_ARGUMENTS} -m solvers
 
       - uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
         with:
@@ -150,6 +182,8 @@ jobs:
     steps:
       - name: Install Git and checkout project
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
 
       - name: Setup Python
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
@@ -175,7 +209,17 @@ jobs:
           .venv\Scripts\Activate.ps1
           # Uninstall conflicting dependencies
           pip uninstall --yes vtk
-          pip install --extra-index-url https://wheels.vtk.org vtk-osmesa==9.3.1
+          pip install --index-url https://wheels.vtk.org vtk-osmesa==9.3.1
+
+      - name: Remove Ansys processes (if any)
+        shell: powershell
+        run: |
+          Get-Process | Where-Object {
+            $_.Path -like "*ansys inc*" -or $_.Path -like "*ansysem*"
+          } | ForEach-Object {
+            Write-Output "Killing $($_.Name) (PID: $($_.Id))"
+            Stop-Process -Id $_.Id -Force
+          }
 
       - name: Run tests marked with 'general'
         uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3.0.2
@@ -212,24 +256,30 @@ jobs:
     steps:
       - name: Install Git and checkout project
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
 
       - name: Setup Python
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
       - name: Create virtual environment
+        env:
+          ANSYSEM: ${{ env.ANSYSEM_ROOT252 }}
         run: |
-          export LD_LIBRARY_PATH=${{ env.ANSYSEM_ROOT252 }}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
+          export LD_LIBRARY_PATH=${ANSYSEM}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
           python -m venv .venv
           source .venv/bin/activate
           python -m pip install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org pip -U
           python -m pip install --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org wheel setuptools -U
           python -c "import sys; print(sys.executable)"
 
       - name: Install pyaedt and tests dependencies
+        env:
+          ANSYSEM: ${{ env.ANSYSEM_ROOT252 }}
         run: |
-          export LD_LIBRARY_PATH=${{ env.ANSYSEM_ROOT252 }}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
+          export LD_LIBRARY_PATH=${ANSYSEM}/common/mono/Linux64/lib64:$LD_LIBRARY_PATH
           source .venv/bin/activate
           pip install .[tests]
           pip install pytest-azurepipelines
@@ -239,7 +289,15 @@ jobs:
           source .venv/bin/activate
           # Uninstall conflicting dependencies
           pip uninstall --yes vtk
-          pip install --extra-index-url https://wheels.vtk.org vtk-osmesa==9.3.1
+          pip install --index-url https://wheels.vtk.org vtk-osmesa==9.3.1
+
+      - name: Remove Ansys processes (if any)
+        shell: bash
+        run: |
+          for pid in $(ps -eo pid,comm,args | grep -iE "ansys.inc|ansysem" | grep -v grep | awk '{print $1}'); do
+            echo "Killing PID $pid"
+            kill -9 "$pid"
+          done
 
       - name: Run tests marked with 'general'
         uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3.0.2

.github/workflows/manual_draft.yml

@@ -14,16 +14,25 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+permissions: {} # Disable default permissions
+
 jobs:
 
   doc-build:
     name: Documentation build
     runs-on: ubuntu-latest
     steps:
+      - name: Temporary handle broken package dependencies
+        shell: bash
+        run: |
+          sudo apt-get update
+          sudo apt-get --fix-broken install -y
+          sudo apt-get install -y graphviz texlive-latex-extra latexmk texlive-xetex texlive-fonts-extra
+
       - name: Documentation build
-        uses: ansys/actions/doc-build@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/doc-build@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5
         with:
-          dependencies: "graphviz texlive-latex-extra latexmk texlive-xetex texlive-fonts-extra"
+          # dependencies: "graphviz texlive-latex-extra latexmk texlive-xetex texlive-fonts-extra"
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           sphinxopts: '-j auto --color -w build_errors.txt'
           check-links: false
@@ -33,9 +42,11 @@ jobs:
     name: Upload dev documentation
     runs-on: ubuntu-latest
     needs: doc-build
+    permissions:
+      contents: write
     steps:
       - name: Upload development documentation
-        uses: ansys/actions/doc-deploy-dev@e0de7dd89b2a4c100f74327666d5521cfda17950 # v10.1.1
+        uses: ansys/actions/doc-deploy-dev@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/nightly-docs.yml

@@ -372,12 +372,11 @@ dist/
 /htmlcov/
 /coverage.xml
 /tests/system/general/coverage.xml
-/tests/system/general/local_config.json
 /tests/system/solvers/coverage.xml
-/tests/system/solvers/local_config.json
 /tests/unit/coverage.xml
 test-results.xml
 test-output.xml
+*local_config.json
 
 # Scratch Jupyter Notebooks
 scratch_notebooks/
@@ -397,13 +396,10 @@ model.index\+
 
 # local environment settings used by e.g. Visual Studio Code
 /.env
-/doc/source/local_config.json
 /.venv*
 
 # test coverage output
 /.cov/
-/tests/system/visualization/local_config.json
-/tests/system/general/pyaedt_settings.yaml
 
 # Custom instructions for GitHub Copilot
 .github/copilot-instructions.md

.gitignore

@@ -47,6 +47,7 @@
 * [German](https://github.com/germa89)
 * [gkorompi](https://github.com/gkorompi)
 * [gmalinve](https://github.com/gmalinve)
+* [GongYeSUDA](https://github.com/GongYeSUDA)
 * [HaiwenZhang](https://github.com/HaiwenZhang)
 * [Hui Zhou](https://github.com/hui-zhou-a)
 * [Irene Woyna](https://github.com/IreneWoyna)
@@ -84,6 +85,7 @@
 * [Patrick J. O'Brien](https://github.com/obrienpja)
 * [pblarsen-ansys](https://github.com/pblarsen-ansys)
 * [Peter Elmers](https://github.com/pelmers)
+* [PositroniumJS](https://github.com/PositroniumJS)
 * [Pumichat (Kla)](https://github.com/anspraksaph)
 * [Ramin Aghajafari](https://github.com/ramin4667)
 * [Revathy Venugopal](https://github.com/Revathyvenugopal162)
@@ -107,10 +109,12 @@
 * [Tadahiro Negishi](https://github.com/tadanegishi)
 * [Tejas Jeurkar](https://github.com/TejasJe)
 * [Tiziana Bertoncelli](https://github.com/tizianrot)
+* [Tushar Bana](https://github.com/tusharbana-ansys)
 * [Valérie Gelbgras](https://github.com/vgelbgras)
 * [Vinod_GPS_Ansys](https://github.com/pvinod13)
 * [voss70](https://github.com/voss70)
 * [vossleon](https://github.com/vossleon)
 * [vpipidis](https://github.com/vpipidis)
+* [Xiaoyang Ma](https://github.com/boltma)
 * [XZ](https://github.com/atlanswer)
 * [Zeba](https://github.com/zebanaqviWAT)

CONTRIBUTORS.md

@@ -1 +1,4 @@
 global-include ansys.aedt.core *.txt *.md *.toml *.json *.png *.xml *.areg *.joblib *.acf *.m *.ipynb *.py_build
+include src/ansys/aedt/core/syslib/**/*.so
+include src/ansys/aedt/core/syslib/**/*.pyd
+include src/ansys/aedt/core/syslib/**/*.license

MANIFEST.in

@@ -48,12 +48,17 @@ You can install PyAEDT on CPython 3.8 through 3.12 from PyPI with this command:
   pip install pyaedt
 ```
 
-Install PyAEDT with all extra packages (matplotlib, numpy, pandas, pyvista):
+Install PyAEDT with all extra packages (matplotlib, numpy, pandas, pyvista, ...):
 
 ```sh
   pip install pyaedt[all]
 ```
 
+> **Note:**
+The [all] installation target includes `fpdf2` for PDF export functionality, which is
+under license LGPL v3. For license-sensitive environments, install PyAEDT without [all]
+and add dependencies individually.
+
 You can also install PyAEDT from Conda-Forge with this command:
 
 ```sh
@@ -305,6 +310,11 @@ On any Windows client machine:
 
 PyAEDT is licensed under the MIT license.
 
+PyAEDT provides an optional PDF export feature via the class `AnsysReport`.
+It requires the [fpdf2](https://github.com/py-pdf/fpdf2)
+library, which is licensed under the
+[GNU Lesser General Public License v3.0 (LGPLv3)](https://www.gnu.org/licenses/lgpl-3.0.en.html#license-text).
+
 PyAEDT makes no commercial claim over Ansys whatsoever. This library extends the
 functionality of AEDT by adding a Python interface to AEDT without changing the
 core behavior or license of the original software. The use of PyAEDT requires a