FEAT: Adding PyMechanical (#223)

Author: RobPasMue

.github/workflows/create-milestone.yml

@@ -37,6 +37,7 @@ jobs:
             "pyansys/pymotorcad",
             "pyansys/pyansys-math",
             "pyansys/pyoptislang",
+            "pyansys/pymechanical",
           ]
     steps:
       - uses: actions/checkout@v3

README.rst

@@ -44,7 +44,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 - `PyFluent <https://fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent.
 - `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.
-- `PyMAPDL <https://mapdl.docs.pyansys.com/>`_: Pythonic interface to Ansys MAPDL (Mechanical APLD).
+- `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).
 - `PyMotorCAD <https://motorcad.docs.pyansys.com/>`_: Pythonic interface to Ansys Motor-CAD.
 - `PyOptislang <https://optislang.docs.pyansys.com/>`_: Pythonic interface to Ansys Optislang.

doc/source/_static/thumbnails/pymechanical.png

@@ -80,6 +80,12 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyMechanical
+      :img-top: _static/thumbnails/pymechanical.png
+      :link: https://mechanical.docs.pyansys.com/version/stable/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMotorCAD
       :img-top: _static/thumbnails/pymotorcad.png
       :link: https://motorcad.docs.pyansys.com/version/stable/methods/index.html

doc/source/api.rst

@@ -69,6 +69,12 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyMechanical
+      :img-top: _static/thumbnails/pymechanical.png
+      :link: https://mechanical.docs.pyansys.com/version/stable/examples/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMotorCAD
       :img-top: _static/thumbnails/pymotorcad.png
       :link: https://motorcad.docs.pyansys.com/version/stable/examples/index.html

doc/source/examples.rst

@@ -86,7 +86,7 @@ it is now a collection of many Python packages for using Ansys products through
       :text-align: center
       :class-title: pyansys-card-title
 
-      Pythonic interface to Ansys MAPDL (Mechanical APLD)
+      Pythonic interface to Ansys MAPDL (Mechanical APDL)
 
     .. grid-item-card:: PyMAPDL Reader
       :img-top: _static/thumbnails/pymapdl.png
@@ -96,21 +96,29 @@ it is now a collection of many Python packages for using Ansys products through
 
       Pythonic interface to read legacy MAPDL result files (MAPDL 14.5 and later)
 
+    .. grid-item-card:: PyMechanical
+      :img-top: _static/thumbnails/pymechanical.png
+      :link: https://mechanical.docs.pyansys.com/
+      :text-align: center
+      :class-title: pyansys-card-title
+
+      Pythonic interface to Ansys Mechanical
+
     .. grid-item-card:: PyMotorCAD
       :img-top: _static/thumbnails/pymotorcad.png
       :link: https://motorcad.docs.pyansys.com/
       :text-align: center
       :class-title: pyansys-card-title
 
-      Pythonic interface to Ansys Motor-CAD.
+      Pythonic interface to Ansys Motor-CAD
 
     .. grid-item-card:: PyOptislang
       :img-top: _static/thumbnails/pyoptislang.png
       :link: https://optislang.docs.pyansys.com/
       :text-align: center
       :class-title: pyansys-card-title
 
-      Pythonic interface to Ansys Optislang.
+      Pythonic interface to Ansys Optislang
 
     .. grid-item-card:: PyPIM
       :img-top: _static/thumbnails/intro.png

doc/source/index.rst

@@ -72,6 +72,12 @@ PyAnsys packages user guides
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyMechanical
+      :img-top: _static/thumbnails/pymechanical.png
+      :link: https://mechanical.docs.pyansys.com/version/stable/index.html#background
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMotorCAD
       :img-top: _static/thumbnails/pymotorcad.png
       :link: https://motorcad.docs.pyansys.com/version/stable/user_guide/index.html

doc/source/user_guide.rst

@@ -44,6 +44,7 @@ dependencies = [
     "ansys-motorcad-core==0.1.3",
     "ansys-math-core==0.1.0",
     "ansys-optislang-core==0.2.0",
+    "ansys-mechanical-core==0.7.1",
 ]
 
 [project.optional-dependencies]