Merge branch 'main' into feat/supporting-slurm-manager

.devcontainer/codespaces-dev/requirements.txt

@@ -5,7 +5,7 @@ scipy==1.12.0
 pandas==2.2.1
 pyiges[full]==0.3.1
 pytest==8.1.1
-pytest-cov==4.1.0
+pytest-cov==5.0.0
 pyvista==0.43.4
 pyansys-tools-report==0.7.0
 vtk==9.3.0

.devcontainer/codespaces-docs/requirements.txt

@@ -8,7 +8,7 @@ imageio==2.34.0
 jupyter_sphinx==0.5.3
 jupyterlab>=3.2.8
 matplotlib==3.8.3
-numpydoc==1.6.0
+numpydoc==1.7.0
 pandas==2.2.1
 plotly==5.20.0
 pyiges[full]==0.3.1

.devcontainer/devcontainer-local/requirements.txt

@@ -5,7 +5,7 @@ scipy==1.12.0
 pandas==2.2.1
 pyiges[full]==0.3.1
 pytest==8.1.1
-pytest-cov==4.1.0
+pytest-cov==5.0.0
 pyvista==0.43.4
 pyansys-tools-report==0.7.0
 vtk==9.3.0

.github/workflows/ci.yml

@@ -863,7 +863,9 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@v5
+        # TODO: testing SEO improvements. This branch avoids creating a
+        # sitemap.xml pages in opposite to v5.
+        uses: ansys/actions/doc-deploy-stable@feat/seo-improvements
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -906,7 +908,8 @@ jobs:
     needs: [docs-build]
     steps:
       - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@v5
+        # TODO: testing SEO improvements. This branch reuses the "index.html" from the stable version
+        uses: ansys/actions/doc-deploy-dev@feat/seo-improvements
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -951,7 +954,7 @@ jobs:
     steps:
       - uses: actions/[email protected]
       - name: "Set up Julia"
-        uses: julia-actions/setup-julia@v1
+        uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.julia-version }}
 

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
   - id: isort
 
 - repo: https://github.com/numpy/numpydoc
-  rev: v1.6.0
+  rev: v1.7.0
   hooks:
     - id: numpydoc-validation
       exclude: |
@@ -65,6 +65,6 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.0
+  rev: 0.28.1
   hooks:
     - id: check-github-workflows

doc/source/conf.py

@@ -142,6 +142,7 @@
 # notfound.extension
 notfound_template = "404.rst"
 notfound_urls_prefix = "/../"
+html_baseurl = f"https://{cname}/version/stable"
 
 # static path
 html_static_path = ["_static"]

pyproject.toml

@@ -8,7 +8,7 @@ name = "ansys-mapdl-core"
 version = "0.69.dev0"
 description = "A Python wrapper for Ansys MAPDL."
 readme = "README.md"
-requires-python = ">=3.9,<3.13"
+requires-python = ">=3.9,<3.13"  # Update also 'MINIMUM_PYTHON_VERSION' in src/ansys/mapdl/core/__init__.py
 license = {file = "LICENSE"}
 authors = [
     {name = "Ansys, Inc.", email = "[email protected]"},
@@ -69,7 +69,7 @@ tests = [
     "pandas==2.2.1",
     "pyiges[full]==0.3.1",
     "pytest==8.1.1",
-    "pytest-cov==4.1.0",
+    "pytest-cov==5.0.0",
     "pyvista==0.43.4",
     "pyansys-tools-report==0.7.0",
     "vtk==9.3.0",
@@ -88,7 +88,7 @@ doc = [
     "jupyter_sphinx==0.5.3",
     "jupyterlab>=3.2.8",
     "matplotlib==3.8.3",
-    "numpydoc==1.6.0",
+    "numpydoc==1.7.0",
     "pandas==2.2.1",
     "plotly==5.20.0",
     "pyiges[full]==0.3.1",

src/ansys/mapdl/core/__init__.py

@@ -36,7 +36,7 @@
     os.makedirs(USER_DATA_PATH)
 
 DEPRECATING_MINIMUM_PYTHON_VERSION = True
-MINIMUM_PYTHON_VERSION = (3, 8)
+MINIMUM_PYTHON_VERSION = (3, 9)
 
 first_time_file = os.path.join(USER_DATA_PATH, ".firstime")
 if not os.path.exists(first_time_file):  # pragma: no cover

src/ansys/mapdl/core/_commands/apdl/abbreviations.py

@@ -77,8 +77,12 @@ def abbres(self, lab="", fname="", ext="", **kwargs):
         lab
             Label that specifies the read operation:
 
-            Replace current abbreviation set with these abbreviations (default). - Extend current abbreviation set with these abbreviations, replacing any of the
-                              same name that already exist.
+            NEW
+                Replace current abbreviation set with these abbreviations (default).
+
+            CHANGE
+                Extend current abbreviation set with these abbreviations, replacing any of the
+                same name that already exist.
 
         fname
             File name and directory path (248 characters maximum, including the

src/ansys/mapdl/core/_commands/apdl/array_param.py

@@ -32,9 +32,13 @@ def mfouri(self, oper="", coeff="", mode="", isym="", theta="", curve="", **kwar
         oper
             Type of Fourier operation:
 
-            Calculate Fourier coefficients COEFF from MODE, ISYM,
-            THETA, and CURVE. - Evaluate the Fourier curve CURVE from
-            COEFF, MODE, ISYM and THETA.
+            FIT
+              Calculate Fourier coefficients COEFF from MODE, ISYM,
+              THETA, and CURVE.
+
+            EVAL
+              Evaluate the Fourier curve CURVE from
+              COEFF, MODE, ISYM and THETA.
 
         coeff
             Name of the array parameter vector containing the Fourier
@@ -50,7 +54,11 @@ def mfouri(self, oper="", coeff="", mode="", isym="", theta="", curve="", **kwar
             the corresponding Fourier terms.  The vector should contain keys
             for each term as follows:
 
-            Symmetric (cosine) term - Antisymmetric (sine) term.
+            0 or 1
+              Symmetric (cosine) term
+
+            -1
+              Antisymmetric (sine) term.
 
         theta, curve
             Names of the array parameter vectors containing the theta vs. curve
@@ -174,16 +182,22 @@ def moper(
         oper
             Matrix operations:
 
-            * `INVERT` - ``(*MOPER, ParR, Par1, INVERT)``
+            * `INVERT`
+              ``(*MOPER, ParR, Par1, INVERT)``
               Square matrix invert: Inverts the ``n`` x ``n`` matrix in ``Par1``
               into ``ParR``. The matrix must be well conditioned.
 
-              **Warning**: Non-independent or ill-conditioned equations can
-              cause erroneous results. - For large matrices, use the
+              .. warning::
+
+                 Non-independent or ill-conditioned equations can
+                 cause erroneous results.
+
+              For large matrices, use the
               APDL Math operation ``*LSFACTOR`` for efficiency (see APDL
               Math).
 
-            * `MULT` - ``(*MOPER, ParR, Par1, MULT, Par2)``
+            * `MULT`
+              ``(*MOPER, ParR, Par1, MULT, Par2)``
               Matrix multiply: Multiplies ``Par1`` by ``Par2``.  The number of
               rows of ``Par2`` must equal the number of columns of ``Par1`` for
               the operation. If ``Par2`` is input with a number of rows
@@ -192,7 +206,8 @@ def moper(
               number of rows of ``Par2`` equal to the number of columns of
               ``Par1``.
 
-            * `COVAR` - ``(*MOPER, ParR, Par1, COVAR, Par2)``
+            * `COVAR`
+              ``(*MOPER, ParR, Par1, COVAR, Par2)``
               Covariance: The measure of association between two columns
               of the input matrix (``Par1``).  ``Par1``, of size m runs (rows)
               by ``n`` data (columns) is first processed to produce a row
@@ -202,7 +217,8 @@ def moper(
               ``n`` matrix (``ParR``) of covariances (with the variances as the
               diagonal terms).
 
-            * `CORR` - ``(*MOPER, ParR, Par1, CORR, Par2)``
+            * `CORR`
+              ``(*MOPER, ParR, Par1, CORR, Par2)``
               Correlation: The correlation coefficient between two
               variables.  The input matrix (``Par1``), of size m runs (rows)
               by n data (columns), is first processed to produce a row
@@ -212,7 +228,8 @@ def moper(
               ``n`` matrix (``ParR``) of correlation coefficients (with a value
               of 1.0 for the diagonal terms).
 
-            * `SOLV` - ``(*MOPER, ParR, Par1, SOLV, Par2)``
+            * `SOLV`
+              ``(*MOPER, ParR, Par1, SOLV, Par2)``
               Solution of simultaneous equations: Solves the set of ``n``
               equations of n terms of the form ``an_1 x_1 + an_2 x_2 + ... +
               an_n x_n = b_n`` where ``Par1`` contains the matrix of
@@ -226,7 +243,8 @@ def moper(
               APDL Math operation ``*LSFACTOR`` for efficiency (see APDL
               Math).
 
-            * `SORT` - ``(*MOPER, ParR, Par1, SORT, Par2, n1, n2, n3)``
+            * `SORT`
+              ``(*MOPER, ParR, Par1, SORT, Par2, n1, n2, n3)``
               Matrix sort: Sorts matrix ``Par1`` according to sort vector
               ``Par2`` and places the result back in ``Par1``. Rows of ``Par1`` are
               moved to the corresponding positions indicated by the
@@ -238,23 +256,26 @@ def moper(
               row positions (the permutation vector).  Sorting ``Par1``
               according to ``ParR`` should reproduce the initial ordering.
 
-            * `NNEAR` - ``(*MOPER, ParR, Par1, NNEAR, Toler)``
+            * `NNEAR`
+              ``(*MOPER, ParR, Par1, NNEAR, Toler)``
               Nearest Node: Quickly determine all the nodes within a
               specified tolerance of a given array.  ``ParR`` is a vector of
               the nearest selected nodes, or 0 if no nodes are nearer
               than ``Toler``. ``Par1`` is the ``n`` x 3 array of coordinate
               locations. ``Toler`` defaults to 1 and is limited to the
               maximum model size.
 
-            * `ENEAR` - ``(*MOPER, ``ParR``, ``Par1``, ENEAR, Toler)``
+            * `ENEAR`
+              ``(*MOPER, ``ParR``, ``Par1``, ENEAR, Toler)``
               Nearest Element: Quickly determine the elements with
               centroids that are within a specified tolerance of the
               points in a given array. - ``ParR`` is a vector of the nearest
               selected elements, or 0 if no element centroids are nearer
               than ``Toler``. ``Par1`` is the ``n`` x 3 array of coordinate
               locations.
 
-            * `MAP` - ``(*MOPER, ParR, Par1, MAP, Par2, Par3, kDim, --, kOut, LIMIT)``
+            * `MAP`
+              ``(*MOPER, ParR, Par1, MAP, Par2, Par3, kDim, --, kOut, LIMIT)``
               Maps the results from one set of points to another. For
               example, you can map pressures from a CFD analysis onto
               your model for a structural analysis.
@@ -297,14 +318,16 @@ def moper(
               bounds. Results mapping is available from the command line
               only.
 
-            * `INTP` - ``(*MOPER, ParR, Par1, INTP, Par2)``
+            * `INTP`
+              ``(*MOPER, ParR, Par1, INTP, Par2)``
               Finds the elements that contain each point in the array of
               ``n`` x 3 points in ``Par1``. ``Par2`` will contain the set of element
               ID numbers and ``ParR`` will contain their ``n`` x 3 set of
               natural element coordinates (values between -1 and
               1). ``Par1`` must be in global Cartesian coordinates.
 
-            * `SGET` - ``(*MOPER, ParR, Par1, SGET, Par2, Label, Comp)``
+            * `SGET`
+              ``(*MOPER, ParR, Par1, SGET, Par2, Label, Comp)``
               Gets the nodal solution item corresponding to Label and
               Comp (see the PLNSOL command) and interpolates it to the
               given element locations. ``Par1`` contains the ``n`` x 3 array of
@@ -1141,7 +1164,8 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
               First derivative:
 
               .. math::
-                 \dfrac{\mathrm{d}(\mathrm{Par1})}{\mathrm{d}(\mathrm{Par2})}
+
+                 \\dfrac{\\mathrm{d}(\\mathrm{Par1})}{\\mathrm{d}(\\mathrm{Par2})}
 
               The derivative at a point is determined over points
               half way between the previous and next points
@@ -1154,7 +1178,8 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
               Second derivative:
 
               .. math::
-                 \dfrac{\mathrm{d}^2(\mathrm{Par1})}{\mathrm{d}(\mathrm{Par2})^2}
+
+                 \\dfrac{\\mathrm{d}^2(\\mathrm{Par1})}{\\mathrm{d}(\\mathrm{Par2})^2}
 
               See also ``DER1``.
 
@@ -1163,7 +1188,7 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
 
               .. math::
 
-                 \int Par1 \, d(Par2)
+                 \\int Par1 \\, d(Par2)
 
               where ``CON1`` is the integration constant.
               The integral at a point is
@@ -1175,7 +1200,7 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
 
               .. math::
 
-                 \iint Par1 \, d(Par2)
+                 \\iint Par1 \\, d(Par2)
 
               where ``CON1`` is the integration constant of the first
               integral and ``CON2`` is the integration constant

src/ansys/mapdl/core/_commands/apdl/macro_files.py

@@ -356,7 +356,7 @@ def rmdir(self, dir_="", **kwargs):
 
         Parameters
         ----------
-        dir\_
+        dir\\_
             The directory to remove. If no path is provided, it will be assumed
             to be in the current working directory. All files in the directory
             are also removed.

src/ansys/mapdl/core/_commands/apdl/matrix_op.py

@@ -102,7 +102,7 @@ def dmat(
         matrix
             Name used to identify the matrix. Must be specified.
 
-        type\_
+        type\\_
             Matrix type:
 
             Double precision real values (default). - Complex double precision values.
@@ -239,7 +239,7 @@ def export(
             Name of the matrix to export (must be a matrix previously created
             with ``*DMAT`` or ``*SMAT``, or a vector previously created with ``*VEC``).
 
-        format\_
+        format\\_
             Format of the output file:
 
             Export the matrix in the Matrix Market Format. - Export
@@ -302,7 +302,7 @@ def fft(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Type of FFT transformation:
 
             Forward FFT computation (default). - Backward FFT computation.
@@ -420,7 +420,7 @@ def itengine(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Specifies the algorithm to be used:
 
         enginename
@@ -834,7 +834,7 @@ def smat(
         matrix
             Name used to identify the matrix. Must be specified.
 
-        type\_
+        type\\_
             Matrix type:
 
             Double precision real values (default). - Complex double precision values.

src/ansys/mapdl/core/_commands/apdl/parameter_definition.py

@@ -65,7 +65,7 @@ def dim(
             Name of parameter to be dimensioned.  See ``*SET`` for name
             restrictions.
 
-        type\_
+        type\\_
             Array type:
 
             Arrays are similar to standard FORTRAN arrays (indices are
@@ -261,7 +261,7 @@ def get(
         Parameters
         ----------
         par : str, optional
-            The name of the resulting parameter. See \*SET for name
+            The name of the resulting parameter. See \\*SET for name
             restrictions.
 
         entity