Getting started#

PyMechanical is part of the broader PyAnsys initiative, enabling the use of Ansys technologies directly from Python. It provides two modes for working with Mechanical:

  • Embedding mode: In-process, full API access

  • Remote session mode: Separate process, gRPC access.

Installation guide

Install and verify PyMechanical.

Installation guide
Choose your mode

Compare embedding and remote session modes. Pick the correct one for your workflow.

Choose your mode
Launching PyMechanical

Launch, connect, and run your first script in either mode.

Launching PyMechanical
Docker setup

Run Mechanical in Docker containers (remote session mode).

Using Mechanical through Docker
Windows Subsystem for Linux (WSL)

Install and run PyMechanical on Linux with WSL.

Windows Subsystem for Linux (WSL)
Troubleshooting

Fix common launch, licensing, and VPN issues.

Troubleshooting