Skip to content

DOC: Improve documentation for the embedded instances. #663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MaxJPRey merged 5 commits into from
Mar 27, 2024
Merged

DOC: Improve documentation for the embedded instances. #663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
db7ef39
Improve documentation for the embedded instances.
MaxJPRey Mar 26, 2024
a2d651c
Merge branch 'main' into doc/embedded
dipinknair Mar 27, 2024
bcf5388
Merge branch 'main' into doc/embedded
klmcadams Mar 27, 2024
33638ea
Adding changelog entry: 663.miscellaneous.md
pyansys-ci-bot Mar 27, 2024
b7260ec
Update doc/source/user_guide_embedding/index.rst
MaxJPRey Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changelog.d/663.miscellaneous.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DOC: Improve documentation for the embedded instances.
12 changes: 6 additions & 6 deletions doc/source/user_guide_embedding/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This section provides an overview of how you use PyMechanical to embed
an instance of Mechanical in Python.

..
This toctreemust be a top-level index to get it to show up in
This toctree must be a top-level index to get it to show up in
pydata_sphinx_theme.

.. toctree::
Expand Down Expand Up @@ -55,15 +55,15 @@ uses the same Addin configuration as standalone Mechanical. To customize Addins,
Diagnosing problems with embedding
----------------------------------

In some cases, debugging why the embedded Mechanical instance is not working requires additional logging.
In some cases, debugging the embedded Mechanical instance may require additional logging.
For information on how to configure logging, see :ref:`ref_embedding_user_guide_logging`.

Running PyMechanical embedding scripts inside Mechanical with IronPython
------------------------------------------------------------------------

If your PyMechanical embedding script does not use any other third-party Python package, such as `NumPy`,
it is possible to adapt it so that it can run inside of Mechanical with IronPython with scripting inside
Mechanical's command line interface. For instance, the consider the following PyMechanical code:
it is possible to adapt it so that it can run inside of Mechanical with IronPython.
The scripting occurs inside Mechanical's command line interface. For instance, consider the following PyMechanical code:

.. code:: python

Expand Down Expand Up @@ -105,7 +105,7 @@ versions can be specified using ``-r`` flag. Use ``-h`` for more information.

.. code::

"C:/Program Files/ANSYS Inc/v231/aisol/bin/winx64/AnsysWBU.exe -DSApplet -AppModeMech -script file.py"
"C:/Program Files/ANSYS Inc/v241/aisol/bin/winx64/AnsysWBU.exe -DSApplet -AppModeMech -script file.py"

PowerShell users can run the preceding command without including the opening and
closing quotation marks.
Expand All @@ -119,4 +119,4 @@ versions can be specified using ``-r`` flag. Use ``-h`` for more information.

``-nosplash`` and ``-notabctrl`` not needed for versions 23.2 or above

On either Windows or Linux, add the command line argument ``-b`` to run the script in batch mode.
On either Windows or Linux, add the command line argument ``-b`` to run the script in batch mode.