Overview
PyMechanical is a Python interface for Ansys Mechanical (FEA software for structural engineering), enabling automation and integration of simulation workflows from 2024 R2 and later.
PyMechanical provides two distinct modes of interaction:
Embedding mode — Run Mechanical directly in your Python process via the App class. Full object-model access, fast startup, ideal for Jupyter notebooks and interactive scripting.
Remote session mode — Launch Mechanical as a separate server process and communicate via gRPC. Process isolation, optional GUI, ideal for CI/CD, Docker, and automation.
Compatibility
Python: 3.12 - 3.14
Mechanical: 2024 R2 (v242) and later
Platforms: Windows, Linux
Installation
Install from PyPI:
pip install ansys-mechanical-core
For graphics support:
pip install ansys-mechanical-core[graphics]
For RPC functionality:
pip install ansys-mechanical-core[rpc]
For AI assistant integration via the Model Context Protocol (MCP):
pip install ansys-mechanical-core[mcp]
Requirements:
Licensed copy of Ansys Mechanical (2024 R2 or later).
For embedded mode: Local Mechanical installation required.
For remote session mode: Network access to a running Mechanical instance.
Quick start
Embedding mode:
from ansys.mechanical.core import App
app = App(globals=globals())
print(app)
# Access Mechanical objects directly
Model.AddStaticStructuralAnalysis()Remote session mode:
from ansys.mechanical.core import launch_mechanical
mechanical = launch_mechanical()
result = mechanical.run_python_script("2+3")
print(result) # Output: 5
mechanical.exit()Connect to existing instance:
from ansys.mechanical.core import connect_to_mechanical
mechanical = connect_to_mechanical(port=10000)
result = mechanical.run_python_script("Model.Name")
print(result)Troubleshooting
Connection refused: Ensure Mechanical is running and the port is accessible.
License error: Verify your Ansys license is properly configured.
Import error: Check that ansys-pythonnet is installed (not pythonnet).
Linux embedding: Use mechanical-env to run Python scripts for embedded mode.
Documentation and support
PyMechanical-MCP — AI assistant integration via MCP
Issues — report bugs or request features
Discussions — ask questions
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ansys_mechanical_core-0.13.2.tar.gz.
File metadata
- Download URL: ansys_mechanical_core-0.13.2.tar.gz
- Upload date:
- Size: 105.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
950ebe32fef3fca5570ffa262a7ab19d33939025997312facd975838dd851fa1
|
|
| MD5 |
3991476285cb1233eb402442b0afbd5e
|
|
| BLAKE2b-256 |
579deac2c8c39ea4be357e1843f57e43ae01a3da69bff6974977f85f46d6c047
|
Provenance
The following attestation bundles were made for ansys_mechanical_core-0.13.2.tar.gz:
Publisher:
ci_cd.yml on ansys/pymechanical
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansys_mechanical_core-0.13.2.tar.gz -
Subject digest:
950ebe32fef3fca5570ffa262a7ab19d33939025997312facd975838dd851fa1 - Sigstore transparency entry: 2347963081
- Sigstore integration time:
-
Permalink:
ansys/pymechanical@e035a4cbb6459660a2a9ff16f4ebfe43cbc13218 -
Branch / Tag:
refs/tags/v0.13.2 - Owner: https://github.com/ansys
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_cd.yml@e035a4cbb6459660a2a9ff16f4ebfe43cbc13218 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ansys_mechanical_core-0.13.2-py3-none-any.whl.
File metadata
- Download URL: ansys_mechanical_core-0.13.2-py3-none-any.whl
- Upload date:
- Size: 162.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a2a9372fb5a4af0aa521277b764ae817beed7561ef71329ce3ec8a8ec246cc95
|
|
| MD5 |
7e3c100c2652ab7e1a8bd059dc4e9acf
|
|
| BLAKE2b-256 |
d9619243dd0585e0122906e145ea9d1cd442d3029f0678a0600d932ec6c3f276
|
Provenance
The following attestation bundles were made for ansys_mechanical_core-0.13.2-py3-none-any.whl:
Publisher:
ci_cd.yml on ansys/pymechanical
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansys_mechanical_core-0.13.2-py3-none-any.whl -
Subject digest:
a2a9372fb5a4af0aa521277b764ae817beed7561ef71329ce3ec8a8ec246cc95 - Sigstore transparency entry: 2347963789
- Sigstore integration time:
-
Permalink:
ansys/pymechanical@e035a4cbb6459660a2a9ff16f4ebfe43cbc13218 -
Branch / Tag:
refs/tags/v0.13.2 - Owner: https://github.com/ansys
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_cd.yml@e035a4cbb6459660a2a9ff16f4ebfe43cbc13218 -
Trigger Event:
push
-
Statement type:
