ansys-mechanical-core 0.10.10__tar.gz → 0.11.12__tar.gz

{ansys_mechanical_core-0.10.10 → ansys_mechanical_core-0.11.12}/LICENSE

@@ -1,13 +1,13 @@
 MIT License
 
-Copyright (c) 2024 ANSYS, Inc. All rights reserved.
+Copyright (c) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

{ansys_mechanical_core-0.10.10 → ansys_mechanical_core-0.11.12}/PKG-INFO

@@ -1,71 +1,78 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: ansys-mechanical-core
-Version: 0.10.10
+Version: 0.11.12
 Summary: A python wrapper for Ansys Mechanical
+Keywords: pymechanical,mechanical,ansys,pyansys
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10,<4.0
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Dist: ansys_api_mechanical==0.1.1
-Requires-Dist: ansys-mechanical-env==0.1.6
+Requires-Dist: ansys-api-mechanical==0.1.2
+Requires-Dist: ansys-mechanical-env==0.1.9
+Requires-Dist: ansys-mechanical-stubs==0.1.6
 Requires-Dist: ansys-platform-instancemanagement>=1.0.1
 Requires-Dist: ansys-pythonnet>=3.1.0rc2
 Requires-Dist: ansys-tools-path>=0.3.1
 Requires-Dist: appdirs>=1.4.0
 Requires-Dist: click>=8.1.3
-Requires-Dist: clr-loader==0.2.6
+Requires-Dist: clr-loader==0.2.7.post0
 Requires-Dist: grpcio>=1.30.0
-Requires-Dist: protobuf>=3.12.2
+Requires-Dist: protobuf>=3.12.2,<6
+Requires-Dist: psutil==6.1.1
 Requires-Dist: tqdm>=4.45.0
-Requires-Dist: Sphinx==7.3.7 ; extra == "doc"
-Requires-Dist: ansys-sphinx-theme==0.15.2 ; extra == "doc"
-Requires-Dist: grpcio==1.62.2 ; extra == "doc"
-Requires-Dist: imageio-ffmpeg==0.4.9 ; extra == "doc"
-Requires-Dist: imageio==2.34.1 ; extra == "doc"
+Requires-Dist: requests>=2,<3
+Requires-Dist: sphinx==8.1.3 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme[autoapi]==1.2.6 ; extra == "doc"
+Requires-Dist: grpcio==1.69.0 ; extra == "doc"
+Requires-Dist: imageio-ffmpeg==0.5.1 ; extra == "doc"
+Requires-Dist: imageio==2.36.1 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: jupyterlab>=3.2.8 ; extra == "doc"
-Requires-Dist: matplotlib==3.8.4 ; extra == "doc"
-Requires-Dist: numpy==1.26.4 ; extra == "doc"
-Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
-Requires-Dist: pandas==2.2.2 ; extra == "doc"
-Requires-Dist: panel==1.4.1 ; extra == "doc"
-Requires-Dist: plotly==5.21.0 ; extra == "doc"
-Requires-Dist: pypandoc==1.13 ; extra == "doc"
+Requires-Dist: matplotlib==3.10.0 ; extra == "doc"
+Requires-Dist: numpy==2.2.1 ; extra == "doc"
+Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
+Requires-Dist: pandas==2.2.3 ; extra == "doc"
+Requires-Dist: panel==1.5.5 ; extra == "doc"
+Requires-Dist: plotly==5.24.1 ; extra == "doc"
+Requires-Dist: pypandoc==1.15 ; extra == "doc"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "doc"
 Requires-Dist: pythreejs==2.4.2 ; extra == "doc"
-Requires-Dist: pyvista==0.43.5 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2024.4.16 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.1.0 ; extra == "doc"
+Requires-Dist: pyvista>=0.39.1 ; extra == "doc"
+Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==3.0.0 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: sphinx_design==0.5.0 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.15.0 ; extra == "doc"
-Requires-Dist: sphinx-notfound-page==1.0.0 ; extra == "doc"
-Requires-Dist: sphinxcontrib-websupport==1.2.7 ; extra == "doc"
+Requires-Dist: sphinx_design==0.6.1 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.18.0 ; extra == "doc"
+Requires-Dist: sphinx-notfound-page==1.0.4 ; extra == "doc"
+Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "doc"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
-Requires-Dist: pytest==8.1.1 ; extra == "tests"
-Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
-Requires-Dist: pytest-print==1.0.0 ; extra == "tests"
-Requires-Dist: pyvista>=0.39.1 ; extra == "viz"
-Requires-Dist: usd-core==24.3 ; extra == "viz"
+Requires-Dist: pytest==8.3.4 ; extra == "tests"
+Requires-Dist: pytest-cov==6.0.0 ; extra == "tests"
+Requires-Dist: pytest-print==1.0.2 ; extra == "tests"
+Requires-Dist: psutil==6.1.1 ; extra == "tests"
+Requires-Dist: ansys-tools-visualization-interface>=0.2.6 ; extra == "viz"
+Requires-Dist: usd-core==24.11 ; extra == "viz"
+Project-URL: Changelog, https://mechanical.docs.pyansys.com/version/stable/changelog.html
 Project-URL: Documentation, https://mechanical.docs.pyansys.com
 Project-URL: Homepage, https://github.com/ansys/pymechanical
-Project-URL: Source, https://github.com/ansys/pymechanical
-Project-URL: Tracker, https://github.com/ansys/pymechanical/issues
+Project-URL: Issues, https://github.com/ansys/pymechanical/issues
+Project-URL: Repository, https://github.com/ansys/pymechanical
 Provides-Extra: doc
 Provides-Extra: tests
 Provides-Extra: viz
 
-.. image:: https://raw.githubusercontent.com/ansys/pymechanical/main/doc/source/_static/logo/pymechanical-logo-light.png
+.. image:: https://raw.githubusercontent.com/ansys/pymechanical/main/doc/source/_static/logo/pymechanical-logo.png
    :alt: PyMechanical logo
+   :width: 580px
 
 
 |pyansys| |pypi| |python| |GH-CI| |codecov| |MIT| |black|
@@ -83,7 +90,7 @@ Provides-Extra: viz
    :alt: Python
 
 .. |codecov| image:: https://codecov.io/gh/ansys/pymechanical/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/ansys/ansys-mechanical-core
+   :target: https://app.codecov.io/gh/ansys/pymechanical
    :alt: Codecov
 
 .. |GH-CI| image:: https://github.com/ansys/pymechanical/actions/workflows/ci_cd.yml/badge.svg
@@ -98,9 +105,13 @@ Provides-Extra: viz
    :target: https://github.com/psf/black
    :alt: Black
 
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pymechanical/main.svg?style=flat
+   :target: https://results.pre-commit.ci/latest/github/ansys/pymechanical/main
+   :alt: pre-commit
 
 Overview
 --------
+
 PyMechanical brings Ansys Mechanical to Python. It enables your Python programs to use
 Mechanical within Python's ecosystem. It includes the ability to:
 
@@ -110,7 +121,8 @@ Mechanical within Python's ecosystem. It includes the ability to:
 
 Install the package
 -------------------
-Install PyMechanical using `pip` with::
+
+Install PyMechanical using ``pip`` with::
 
    pip install ansys-mechanical-core
 
@@ -129,16 +141,17 @@ session must be reachable from your Python program.
 Getting started
 ---------------
 
+.. _scripting_guide: https://ansyshelp.ansys.com/Views/Secured/corp/v251/en/act_script/act_script.html
+
 PyMechanical uses the built-in scripting capabilities of Mechanical. For information on the
-scripting APIs available, see the `Scripting in Mechanical Guide
-<https://ansyshelp.ansys.com/Views/Secured/corp/v241/en/act_script/act_script.html>`_ in the
+scripting APIs available, see the `Scripting in Mechanical Guide <_scripting_guide>`_ in the
 Ansys Help.
 
 Configuring the mechanical installation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 On a Windows system, the environment variable ``AWP_ROOT<ver>`` is configured when Mechanical is
-installed, where ``<ver>`` is the Mechanical release number, such as ``231`` for release 2023 R1.
+installed, where ``<ver>`` is the Mechanical release number, such as ``251`` for release 2025 R1.
 PyMechanical automatically uses this environment variable (or variables if there are multiple
 installations of different versions) to locate the latest Mechanical installation. On a Linux
 system, you must configure the ``AWP_ROOT<ver>`` environment variable to point to the
@@ -173,21 +186,21 @@ Using an embedded instance of Mechanical as a Python object
 
 PyMechanical also supports directly embedding an instance of Mechanical as a Python object.
 In this mode, there is no externally running instance of Mechanical. This feature is supported
-on Windows for version 2023 R1 and later, and on Linux for version 2023 R2
-and later. Here is an example:
+on Windows and Linux for version 2023 R2 and later. Here is an example:
 
 .. code:: python
 
    import ansys.mechanical.core as pymechanical
 
    app = pymechanical.App()
-   project_dir = app.ExtAPI.DataModel.Project.ProjectDirectory
+   app.update_globals(globals())
+   project_dir = DataModel.Project.ProjectDirectory
 
 Documentation and issues
 ------------------------
 
 Documentation for the latest stable release of PyMechanical is hosted at `PyMechanical documentation
-<https://mechanical.docs.pyansys.com/version/stable/>`_.
+<https://mechanical.docs.pyansys.com/>`_.
 
 In the upper right corner of the documentation's title bar, there is an option for switching from
 viewing the documentation for the latest stable release to viewing the documentation for the
@@ -211,15 +224,3 @@ Testing and development
 If you would like to test or contribute to the development of PyMechanical, see
 `Contribute <https://mechanical.docs.pyansys.com/version/stable/contributing.html>`_ in
 the PyMechanical documentation.
-
-.. LINKS AND REFERENCES
-.. _black: https://github.com/psf/black
-.. _flake8: https://flake8.pycqa.org/en/latest/
-.. _isort: https://github.com/PyCQA/isort
-.. _pip: https://pypi.org/project/pip/
-.. _pre-commit: https://pre-commit.com/
-.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/
-.. _pytest: https://docs.pytest.org/en/stable/
-.. _Sphinx: https://www.sphinx-doc.org/en/master/
-.. _tox: https://tox.wiki/
-

{ansys_mechanical_core-0.10.10 → ansys_mechanical_core-0.11.12}/README.rst

@@ -1,158 +1,154 @@
-.. image:: https://raw.githubusercontent.com/ansys/pymechanical/main/doc/source/_static/logo/pymechanical-logo-light.png
-   :alt: PyMechanical logo
-
-
-|pyansys| |pypi| |python| |GH-CI| |codecov| |MIT| |black|
-
-.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
-   :target: https://docs.pyansys.com/
-   :alt: PyAnsys
-
-.. |pypi| image:: https://img.shields.io/pypi/v/ansys-mechanical-core.svg?logo=python&logoColor=white
-   :target: https://pypi.org/project/ansys-mechanical-core
-   :alt: PyPI
-
-.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-mechanical-core?logo=pypi
-   :target: https://pypi.org/project/ansys-mechanical-core
-   :alt: Python
-
-.. |codecov| image:: https://codecov.io/gh/ansys/pymechanical/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/ansys/ansys-mechanical-core
-   :alt: Codecov
-
-.. |GH-CI| image:: https://github.com/ansys/pymechanical/actions/workflows/ci_cd.yml/badge.svg
-   :target: https://github.com/ansys/pymechanical/actions/workflows/ci_cd.yml
-   :alt: GH-CI
-
-.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
-   :target: https://opensource.org/licenses/MIT
-   :alt: MIT
-
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
-   :target: https://github.com/psf/black
-   :alt: Black
-
-
-Overview
---------
-PyMechanical brings Ansys Mechanical to Python. It enables your Python programs to use
-Mechanical within Python's ecosystem. It includes the ability to:
-
-- Connect to a remote Mechanical session
-- Embed an instance of Mechanical directly as a Python object
-
-
-Install the package
--------------------
-Install PyMechanical using `pip` with::
-
-   pip install ansys-mechanical-core
-
-For more information, see `Install the package <https://mechanical.docs.pyansys.com/version/stable/getting_started/index.html>`_
-in the PyMechanical documentation.
-
-
-Dependencies
-------------
-
-You must have a licensed copy of `Ansys Mechanical <https://www.ansys.com/products/structures/ansys-mechanical>`_
-installed. When using an embedded instance, that installation must be runnable from the
-same computer as your Python program. When using a remote session, a connection to that
-session must be reachable from your Python program.
-
-Getting started
----------------
-
-PyMechanical uses the built-in scripting capabilities of Mechanical. For information on the
-scripting APIs available, see the `Scripting in Mechanical Guide
-<https://ansyshelp.ansys.com/Views/Secured/corp/v241/en/act_script/act_script.html>`_ in the
-Ansys Help.
-
-Configuring the mechanical installation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-On a Windows system, the environment variable ``AWP_ROOT<ver>`` is configured when Mechanical is
-installed, where ``<ver>`` is the Mechanical release number, such as ``231`` for release 2023 R1.
-PyMechanical automatically uses this environment variable (or variables if there are multiple
-installations of different versions) to locate the latest Mechanical installation. On a Linux
-system, you must configure the ``AWP_ROOT<ver>`` environment variable to point to the
-absolute path of a Mechanical installation.
-
-Starting a remote session
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To start a remote session of Mechanical on your computer from Python, use the ``launch_mechanical()``
-method. This methods returns an object representing the connection to the session:
-
-.. code:: python
-
-   import ansys.mechanical.core as pymechanical
-
-   mechanical = pymechanical.launch_mechanical()
-
-Running commands on the remote session
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Given a connection to a remote session, you can send an IronPython script. This uses the built-in
-scripting capabilities of Mechanical. Here is an example:
-
-.. code:: python
-
-    result = mechanical.run_python_script("2+3")
-    result = mechanical.run_python_script("ExtAPI.DataModel.Project.ProjectDirectory")
-
-
-Using an embedded instance of Mechanical as a Python object
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-PyMechanical also supports directly embedding an instance of Mechanical as a Python object.
-In this mode, there is no externally running instance of Mechanical. This feature is supported
-on Windows for version 2023 R1 and later, and on Linux for version 2023 R2
-and later. Here is an example:
-
-.. code:: python
-
-   import ansys.mechanical.core as pymechanical
-
-   app = pymechanical.App()
-   project_dir = app.ExtAPI.DataModel.Project.ProjectDirectory
-
-Documentation and issues
-------------------------
-
-Documentation for the latest stable release of PyMechanical is hosted at `PyMechanical documentation
-<https://mechanical.docs.pyansys.com/version/stable/>`_.
-
-In the upper right corner of the documentation's title bar, there is an option for switching from
-viewing the documentation for the latest stable release to viewing the documentation for the
-development version or previously released versions.
-
-You can also `view <https://cheatsheets.docs.pyansys.com/pymechanical_cheat_sheet.png>`_ or
-`download <https://cheatsheets.docs.pyansys.com/pymechanical_cheat_sheet.pdf>`_ the
-PyMechanical cheat sheet. This one-page reference provides syntax rules and commands
-for using PyMechanical.
-
-On the `PyMechanical Issues <https://github.com/ansys/pymechanical/issues>`_ page,
-you can create issues to report bugs and request new features. On the `PyMechanical Discussions
-<https://github.com/ansys/pymechanical/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_
-page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
-
-To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
-
-Testing and development
------------------------
-
-If you would like to test or contribute to the development of PyMechanical, see
-`Contribute <https://mechanical.docs.pyansys.com/version/stable/contributing.html>`_ in
-the PyMechanical documentation.
-
-.. LINKS AND REFERENCES
-.. _black: https://github.com/psf/black
-.. _flake8: https://flake8.pycqa.org/en/latest/
-.. _isort: https://github.com/PyCQA/isort
-.. _pip: https://pypi.org/project/pip/
-.. _pre-commit: https://pre-commit.com/
-.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/
-.. _pytest: https://docs.pytest.org/en/stable/
-.. _Sphinx: https://www.sphinx-doc.org/en/master/
-.. _tox: https://tox.wiki/
+.. image:: https://raw.githubusercontent.com/ansys/pymechanical/main/doc/source/_static/logo/pymechanical-logo.png
+   :alt: PyMechanical logo
+   :width: 580px
+
+
+|pyansys| |pypi| |python| |GH-CI| |codecov| |MIT| |black|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-mechanical-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-mechanical-core
+   :alt: PyPI
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-mechanical-core?logo=pypi
+   :target: https://pypi.org/project/ansys-mechanical-core
+   :alt: Python
+
+.. |codecov| image:: https://codecov.io/gh/ansys/pymechanical/branch/main/graph/badge.svg
+   :target: https://app.codecov.io/gh/ansys/pymechanical
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/pymechanical/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/pymechanical/actions/workflows/ci_cd.yml
+   :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+   :target: https://github.com/psf/black
+   :alt: Black
+
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pymechanical/main.svg?style=flat
+   :target: https://results.pre-commit.ci/latest/github/ansys/pymechanical/main
+   :alt: pre-commit
+
+Overview
+--------
+
+PyMechanical brings Ansys Mechanical to Python. It enables your Python programs to use
+Mechanical within Python's ecosystem. It includes the ability to:
+
+- Connect to a remote Mechanical session
+- Embed an instance of Mechanical directly as a Python object
+
+
+Install the package
+-------------------
+
+Install PyMechanical using ``pip`` with::
+
+   pip install ansys-mechanical-core
+
+For more information, see `Install the package <https://mechanical.docs.pyansys.com/version/stable/getting_started/index.html>`_
+in the PyMechanical documentation.
+
+
+Dependencies
+------------
+
+You must have a licensed copy of `Ansys Mechanical <https://www.ansys.com/products/structures/ansys-mechanical>`_
+installed. When using an embedded instance, that installation must be runnable from the
+same computer as your Python program. When using a remote session, a connection to that
+session must be reachable from your Python program.
+
+Getting started
+---------------
+
+.. _scripting_guide: https://ansyshelp.ansys.com/Views/Secured/corp/v251/en/act_script/act_script.html
+
+PyMechanical uses the built-in scripting capabilities of Mechanical. For information on the
+scripting APIs available, see the `Scripting in Mechanical Guide <_scripting_guide>`_ in the
+Ansys Help.
+
+Configuring the mechanical installation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+On a Windows system, the environment variable ``AWP_ROOT<ver>`` is configured when Mechanical is
+installed, where ``<ver>`` is the Mechanical release number, such as ``251`` for release 2025 R1.
+PyMechanical automatically uses this environment variable (or variables if there are multiple
+installations of different versions) to locate the latest Mechanical installation. On a Linux
+system, you must configure the ``AWP_ROOT<ver>`` environment variable to point to the
+absolute path of a Mechanical installation.
+
+Starting a remote session
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To start a remote session of Mechanical on your computer from Python, use the ``launch_mechanical()``
+method. This methods returns an object representing the connection to the session:
+
+.. code:: python
+
+   import ansys.mechanical.core as pymechanical
+
+   mechanical = pymechanical.launch_mechanical()
+
+Running commands on the remote session
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Given a connection to a remote session, you can send an IronPython script. This uses the built-in
+scripting capabilities of Mechanical. Here is an example:
+
+.. code:: python
+
+    result = mechanical.run_python_script("2+3")
+    result = mechanical.run_python_script("ExtAPI.DataModel.Project.ProjectDirectory")
+
+
+Using an embedded instance of Mechanical as a Python object
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+PyMechanical also supports directly embedding an instance of Mechanical as a Python object.
+In this mode, there is no externally running instance of Mechanical. This feature is supported
+on Windows and Linux for version 2023 R2 and later. Here is an example:
+
+.. code:: python
+
+   import ansys.mechanical.core as pymechanical
+
+   app = pymechanical.App()
+   app.update_globals(globals())
+   project_dir = DataModel.Project.ProjectDirectory
+
+Documentation and issues
+------------------------
+
+Documentation for the latest stable release of PyMechanical is hosted at `PyMechanical documentation
+<https://mechanical.docs.pyansys.com/>`_.
+
+In the upper right corner of the documentation's title bar, there is an option for switching from
+viewing the documentation for the latest stable release to viewing the documentation for the
+development version or previously released versions.
+
+You can also `view <https://cheatsheets.docs.pyansys.com/pymechanical_cheat_sheet.png>`_ or
+`download <https://cheatsheets.docs.pyansys.com/pymechanical_cheat_sheet.pdf>`_ the
+PyMechanical cheat sheet. This one-page reference provides syntax rules and commands
+for using PyMechanical.
+
+On the `PyMechanical Issues <https://github.com/ansys/pymechanical/issues>`_ page,
+you can create issues to report bugs and request new features. On the `PyMechanical Discussions
+<https://github.com/ansys/pymechanical/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_
+page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
+
+To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
+
+Testing and development
+-----------------------
+
+If you would like to test or contribute to the development of PyMechanical, see
+`Contribute <https://mechanical.docs.pyansys.com/version/stable/contributing.html>`_ in
+the PyMechanical documentation.