FEAT: Add known issues and limitation section (#760)

Co-authored-by: pyansys-ci-bot <[email protected]> Co-authored-by: sbradrick <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
ansys · Jul 16, 2024 · 1cee148 · 1cee148
1 parent b8cd6eb
commit 1cee148
Show file tree

Hide file tree

Showing 11 changed files with 112 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -197,6 +197,7 @@ doc/source/examples/gallery_examples/*/*.rst
 doc/source/examples/gallery_examples/*/*.pickle
 doc/source/examples/gallery_examples/**/*.png
 doc/source/sg_execution_times.rst
+
 # Ignore everything in the doc/source/api/ directory
 doc/source/api/*
 # This file is for the ansys-tools-path

diff --git a/doc/changelog.d/760.added.md b/doc/changelog.d/760.added.md
@@ -0,0 +1 @@
+FEAT: Add known issues and limitation section
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -301,6 +301,7 @@
     "https://ansysaccount.b2clogin.com/*",
     "https://answers.microsoft.com/en-us/windows/forum/all/*",
     "https://download.ansys.com/*",
+    "https://support.ansys.com/*",
     "../api/*",  # Remove this after release 0.10.12
     "path.html",
 ]

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -47,6 +47,7 @@
    user_guide_session/index
    user_guide_embedding/index
    user_guide_scripting/index
+   kil/index
    api/index
    contributing
    changelog

diff --git a/doc/source/kil/index.rst b/doc/source/kil/index.rst
@@ -0,0 +1,45 @@
+.. _ref_known_issues_and_limitation:
+
+Known issue and limitations
+===========================
+
+Note the following known issues and limitations. Some features may not be fully compatible across different versions of **Mechanical** and **PyMechanical**.
+Ansys recommends that you always use the latest version of both to achieve the best results.
+
+..
+   This toctree must be a top-level index to get it to show up in
+   pydata_sphinx_theme.
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+
+   mechanical
+   pymechanical
+
+.. grid:: 2
+    :gutter: 2 2 3 4
+
+    .. grid-item-card:: :fas:`fa-solid fa-gears` Mechanical
+        :link: mechanical
+        :link-type: doc
+        :text-align: center
+
+        Known issues and limitations of Standalone Mechanical
+
+    .. grid-item-card:: :fab:`fa-brands fa-python` PyMechanical
+        :link: pymechanical
+        :link-type: doc
+        :text-align: center
+
+        Known issues and limitations of PyMechanical
+
+Support
+=======
+
+If you encounter any issues or limitations that hinder your work, please contact our support team immediately.
+We are committed to providing timely assistance to ensure your projects run smoothly.
+
+- Mechanical : `Customer portal <https://support.ansys.com/>`_
+- PyMechanical : Create issue in github or contact `pyansys team <pyansys_support_>`_
diff --git a/doc/source/kil/mechanical.rst b/doc/source/kil/mechanical.rst
@@ -0,0 +1,33 @@
+.. _ref_kil_mechanical:
+
+Mechanical standalone
+=====================
+
+In addition to Standalone Mechanical known issues and limitations given below,
+please refer
+
+- `Mechanical API known issues and limitations`_.
+- `ACT known issues and limitations`_.
+
+Known issues and limitations
+----------------------------
+
+24R2
+^^^^
+
+- In Read Only mode, the application does not display error messages when the geometry is imported in batch mode.
+- Section planes can not be added through batch mode.
+- Mechanical is not thread safe.
+- Spaceclaim geometry (.scdocx) can not be imported on Linux platform.
+- On Linux based platforms, Ansys Motion and LSDYNA analysis support are limited.
+
+
+24R1
+^^^^
+
+- `Python libraries <https://mechanical.docs.pyansys.com/version/stable/user_guide_embedding/libraries.html>`_
+  that are distributed with the installation of Mechanical does not work when there are syntax differences
+  between IronPython and CPython (`#515 <https://github.com/ansys/pymechanical/issues/515>`_).
+- Trace Import fails with PyMechanical Embedding when using ``python 3.10`` only.
+
+
diff --git a/doc/source/kil/pymechanical.rst b/doc/source/kil/pymechanical.rst
@@ -0,0 +1,17 @@
+.. _ref_kil_pymechanical:
+
+PyMechanical
+============
+
+Known issues and limitations
+----------------------------
+
+We suggest to use latest stable version of PyMechanical.
+Any issues and limitations for previous versions are not currently documented.
+If you find any other, please create an issue `here <pymechanical_issue_>`_
+
+v0.11.x
+^^^^^^^^
+
+- ``App.plot()`` visualization feature is available only for geometry. You cannot plot mesh or results
+  but you can export these data as images or an animation.
diff --git a/doc/source/links.rst b/doc/source/links.rst
@@ -1,7 +1,9 @@
-.. #Pyansys
+.. # Pyansys
 .. _pyansys: https://docs.pyansys.com/
 .. _pyansys_support: [email protected]
 
+.. # PyMechanical related
+.. _pymechanical_issue: https://github.com/ansys/pymechanical/issues
 .. # PyMechanical Embedding Examples related
 .. _pymechanical_embedding_ex_doc: https://embedding.examples.mechanical.docs.pyansys.com/
 .. _pymechanical_embedding_ex_repo: https://github.com/ansys/pymechanical-embedding-examples
@@ -15,4 +17,8 @@
 .. _Mechanical Users Guide: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/wb_sim/ds_Home.html
 .. _Chapter 6: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/installation/unix_silent.html
 .. _Chapter 7: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/installation/win_silent.html
+
+.. # Mechanical related
 .. _ACT API Reference Guide: https://developer.ansys.com/docs/mechanical-scripting-interface/api/ansys/mechanical/stubs/%%VERSION%%/index.md
+.. _Mechanical API known issues and limitations: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/act_script/mech_apis_KIL.html?q=known%20issues
+.. _ACT known issues and limitations: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/%%VERSION%%/en/act_dev/act_dev_knownissues.html
diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt
@@ -55,4 +55,6 @@ cli
 VPN
 ACT
 globaly
-ans
+ans
+spaceclaim
+github
diff --git a/src/ansys/mechanical/core/embedding/imports.py b/src/ansys/mechanical/core/embedding/imports.py
@@ -40,7 +40,8 @@ def global_variables(app: "ansys.mechanical.core.App", enums: bool = False) -> t
 
     It can be used to add all of these as global variables in python
     with this command:
-        `globals().update(global_variables(embedded_app))`
+
+    ``globals().update(global_variables(embedded_app))``
 
     To also import all the enums, set the parameter enums to true.
     """

diff --git a/src/ansys/mechanical/core/misc.py b/src/ansys/mechanical/core/misc.py
@@ -109,7 +109,7 @@ def check_valid_port(port, lower_bound=1000, high_bound=60000):
     """Check if the port is valid.
 
     Parameters
-    ---------
+    ----------
     port : int
         Port to check.
     lower_bound : int, optional
-Original file line number
+Diff line change
@@ Expand Up / @@ -55,4 +55,6 @@ cli @@
     VPN
     ACT
     globaly
-    ans
+    ans
+    spaceclaim
+    github