Merge branch 'main' into release/2024.1

Author: RobPasMue

.gitattributes

@@ -0,0 +1 @@
+* text=auto !eol

.github/workflows/create-milestone.yml

@@ -1,84 +1,87 @@
-name: Create milestones for Ansys Release
-on:
-  workflow_dispatch:
-    inputs:
-      release-date:
-        description: 'Milestone release date (format must be YYYY/MM/DD)'
-        required: true
-        default: '2023/01/30'
-
-env:
-  MAIN_PYTHON_VERSION: '3.11'
-
-jobs:
-  create-milestone:
-    name: Create a milestone in ${{ matrix.pyansys-projects }}
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        pyansys-projects:
-          [
-            "ansys/pyadditive",
-            "ansys/pyaedt",
-            "ansys/pyansys-geometry",
-            "ansys/pyansys-math",
-            "ansys/pydpf-core",
-            "ansys/pydpf-post",
-            "ansys/pydpf-composites",
-            "ansys/pydyna",
-            "ansys/pydynamicreporting",
-            "ansys/pyedb-core",
-            "ansys/pyensight",
-            "ansys/pyfluent",
-            "ansys/pygranta",
-            "ansys/pymapdl",
-            "ansys/pymechanical",
-            "ansys/pymotorcad",
-            "ansys/pyoptislang",
-            "ansys/pypim",
-            "ansys/pyprimemesh",
-            "ansys/pyseascape",
-            "ansys/pysherlock",
-            "ansys/pysystem-coupling",
-            "ansys/pyturbogrid",
-            "ansys/pytwin",
-            "ansys/openapi-common",
-            # MAPDL - ALL
-            "ansys/pymapdl-reader",
-            # FLUENT - ALL
-            "ansys/pyfluent-parametric",
-            "ansys/pyfluent-visualization",
-            # TOOLS
-            "ansys/ansys-tools-path",
-            "ansys/ansys-tools-protoc-helper",
-            "ansys/pyansys-tools-report",
-            "ansys/pyansys-tools-versioning",
-            "ansys/pyansys-units",
-          ]
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
-
-      - name: Linux pip cache
-        uses: actions/cache@v4
-        if: ${{ runner.os == 'Linux' }}
-        with:
-          path: ~/.cache/pip
-          key: Python-${{ runner.os }}-create-milestone
-
-      - name: Install requirements
-        run: |
-          pip install pygithub
-
-      - name: Create the milestone
-        env:
-          TOKEN: ${{ secrets.CREATE_MILESTONE_TOKEN }}
-          REPOSITORY: ${{ matrix.pyansys-projects }}
-          RELEASE_DATE: ${{ github.event.inputs.release-date }}
-        run: |
-          python tools/milestone.py
+name: Create milestones for Ansys Release
+on:
+  workflow_dispatch:
+    inputs:
+      release-date:
+        description: 'Milestone release date (format must be YYYY/MM/DD)'
+        required: true
+        default: '2023/01/30'
+
+env:
+  MAIN_PYTHON_VERSION: '3.11'
+
+jobs:
+  create-milestone:
+    name: Create a milestone in ${{ matrix.pyansys-projects }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        pyansys-projects:
+          [
+            "ansys/openapi-common",
+            "ansys/pyadditive",
+            "ansys/pyaedt",
+            "ansys/pyansys-geometry",
+            "ansys/pyansys-math",
+            "ansys/pydpf-core",
+            "ansys/pydpf-post",
+            "ansys/pydpf-composites",
+            "ansys/pydyna",
+            "ansys/pydynamicreporting",
+            "ansys/pyedb-core",
+            "ansys/pyensight",
+            "ansys/pyfluent",
+            "ansys/pygranta",
+            "ansys/pyhps",
+            "ansys/pymapdl",
+            "ansys/pymechanical",
+            "ansys/pymotorcad",
+            "ansys/pyoptislang",
+            "ansys/pypim",
+            "ansys/pyprimemesh",
+            "ansys/pyrocky",
+            "ansys/pyseascape",
+            "ansys/pysherlock",
+            "ansys/pysimai",
+            "ansys/pysystem-coupling",
+            "ansys/pyturbogrid",
+            "ansys/pytwin",
+            # MAPDL - ALL
+            "ansys/pymapdl-reader",
+            # FLUENT - ALL
+            "ansys/pyfluent-parametric",
+            "ansys/pyfluent-visualization",
+            # TOOLS
+            "ansys/ansys-tools-path",
+            "ansys/ansys-tools-protoc-helper",
+            "ansys/pyansys-tools-report",
+            "ansys/pyansys-tools-versioning",
+            "ansys/pyansys-units",
+          ]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: Linux pip cache
+        uses: actions/cache@v4
+        if: ${{ runner.os == 'Linux' }}
+        with:
+          path: ~/.cache/pip
+          key: Python-${{ runner.os }}-create-milestone
+
+      - name: Install requirements
+        run: |
+          pip install pygithub
+
+      - name: Create the milestone
+        env:
+          TOKEN: ${{ secrets.CREATE_MILESTONE_TOKEN }}
+          REPOSITORY: ${{ matrix.pyansys-projects }}
+          RELEASE_DATE: ${{ github.event.inputs.release-date }}
+        run: |
+          python tools/milestone.py

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 24.1.1
+  rev: 24.2.0
   hooks:
   - id: black
 
@@ -38,12 +38,12 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.27.3
+  rev: 0.28.0
   hooks:
     - id: check-github-workflows
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.2.8
+  rev: v0.2.9
   hooks:
   - id: add-license-headers
     args:

README.rst

@@ -59,15 +59,18 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 - `PyFluent - Parametric <https://parametric.fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent parametric workflows.
 - `PyFluent - Visualization <https://visualization.fluent.docs.pyansys.com/>`_: Pythonic interface to visualize Ansys Fluent simulations.
 - `PyGranta <https://grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI services.
+- `PyHPS <https://hps.docs.pyansys.com/version/dev/>`_: A Python client for Ansys HPC Platform Services (HPS).
 - `PyMAPDL <https://mapdl.docs.pyansys.com/>`_: Pythonic interface to Ansys MAPDL (Mechanical APDL).
 - `PyMAPDL Reader <https://reader.docs.pyansys.com/>`_: Pythonic interface to read legacy MAPDL result files (MAPDL 14.5 and later).
 - `PyMechanical <https://mechanical.docs.pyansys.com/>`_: Pythonic interface to Ansys Mechanical.
 - `PyMotorCAD <https://motorcad.docs.pyansys.com/>`_: Pythonic interface to Ansys Motor-CAD.
 - `PyOptislang <https://optislang.docs.pyansys.com/>`_: Pythonic interface to Ansys Optislang.
 - `PyPIM <https://pypim.docs.pyansys.com/>`_: Pythonic interface to communicate with the Ansys PIM (Product Instance Management) API.
 - `PyPrimeMesh <https://prime.docs.pyansys.com/>`_: Pythonic interface to Ansys Prime Server, which delivers core Ansys meshing technology.
+- `PyRocky <https://rocky.docs.pyansys.com/>`_: Python library to communicate with Ansys Rocky using Rocky PrePost API.
 - `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.
+- `PySimAI <https://simai.docs.pyansys.com/>`_: Pythonic interface to use SimAI.
 - `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.
@@ -101,14 +104,17 @@ By default, the PyAnsys metapackage installs these core modules:
 - `PyEnSight`_
 - `PyFluent`_
 - `PyGranta`_
+- `PyHPS`_
 - `PyMAPDL`_
 - `PyMechanical`_
 - `PyMotorCAD`_
 - `PyOptislang`_
 - `PyPIM`_
 - `PyPrimeMesh`_
+- `PyRocky`_
 - `PySeascape`_
 - `PySherlock`_
+- `PySimAI`_
 - `PySystemCoupling`_
 - `PyTurboGrid`_
 - `PyTwin`_
@@ -173,7 +179,7 @@ commands:
 
 .. code:: bash
 
-    unzip pyansys-v2024.1.5-wheelhouse-Linux-3.9-core.zip wheelhouse
+    unzip pyansys-v2024.2.dev0-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

doc/source/_static/thumbnails/pymapdl.png

@@ -111,6 +111,12 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyHPS
+      :img-top: _static/thumbnails/intro.png
+      :link: https://hps.docs.pyansys.com/version/stable/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMAPDL
       :img-top: _static/thumbnails/pymapdl.png
       :link: https://mapdl.docs.pyansys.com/version/0.67/api/index.html
@@ -153,6 +159,12 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyRocky
+      :img-top: _static/thumbnails/pyrocky.png
+      :link: https://rocky.docs.pyansys.com/version/stable/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PySeascape
       :img-top: _static/thumbnails/intro.png
       :link: https://seascape.docs.pyansys.com/version/0.2/#usage
@@ -165,6 +177,12 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PySimAI
+      :img-top: _static/thumbnails/intro.png
+      :link: https://simai.docs.pyansys.com/version/stable/api_reference.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PySystemCoupling
       :img-top: _static/thumbnails/pysystem-coupling.png
       :link: https://systemcoupling.docs.pyansys.com/version/0.3/api/index.html

doc/source/_static/thumbnails/pymapdl_dark.png

@@ -100,6 +100,12 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyHPS
+      :img-top: _static/thumbnails/intro.png
+      :link: https://hps.docs.pyansys.com/version/stable/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMAPDL
       :img-top: _static/thumbnails/pymapdl.png
       :link: https://mapdl.docs.pyansys.com/version/0.67/examples/index.html
@@ -142,6 +148,12 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyRocky
+      :img-top: _static/thumbnails/pyrocky.png
+      :link: https://rocky.docs.pyansys.com/version/stable/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PySeascape
       :img-top: _static/thumbnails/intro.png
       :link: https://seascape.docs.pyansys.com/version/0.2/#examples
@@ -154,6 +166,12 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PySimAI
+      :img-top: _static/thumbnails/intro.png
+      :link: https://simai.docs.pyansys.com/version/stable/index.html#getting-started
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PySystemCoupling
       :img-top: _static/thumbnails/pysystem-coupling.png
       :link: https://systemcoupling.docs.pyansys.com/version/0.3/examples/index.html