Skip to main content

PyMechanical Cheat Sheet

| 09.05.2023

This is a quick-reference guide for PyMechanical. This guide covers two unique methods, you can jump to a section of your choosing by using these links:

A. Connect to a remote session of Mechanical form Python: Launch and connect to a session | Launch by version | Launch the Mechanical UI | Send Commands to Mechanical

B. Load an embedded instance of Mechanical in Python: Embed a Mechanical Instance


A. Connect to a remote session of Mechanical from Python


Launch and connect to a Session

Launch and connect to Mechanical locally:

import ansys.mechanical.core as pymechanical

mechanical = pymechanical.launch_mechanical()

Launch Mechanical from a local or remote terminal:

> ansys-mechanical -r 232 --port 10000 -g

Manually connect to this Mechanical session from a local client:

import ansys.mechanical.core as pymechanical

# Note: The following code uses port 10000, but you can specify an alternative port if required.
# Either connect locally 
mechanical = pymechanical.Mechanical(port=10000) 

# Or connect remotely, specifying the IP address or hostname and port.
mechanical = pymechanical.Mechanical("", port=10000)


Launch by Version

Verify the license and version of Mechanical that is used:


Launch a specific version of Mechanical:

from ansys.mechanical.core import find_mechanical

wb_exe = find_mechanical(232)[0]
# 'AnsysInc\\v232\\aisol\\bin\\winx64\\AnsysWBU.exe'
mechanical = launch_mechanical(exec_file=wb_exe, verbose_mechanical=True, batch=True)


Launch the Mechanical UI

Launch the Mechanical UI:

mechanical = pymechanical.launch_mechanical(batch=False)


Send Commands to Mechanical

Run a single command:

result1 = mechanical.run_python_script("2+3")
result2 = mechanical.run_python_script("ExtAPI.DataModel.Project.ProjectDirectory")

Execute a block of commands:

# Import a material
commands = """
cu_mat__file_path = r'D:\Workdir\copper.xml'.replace("\\","\\\\")
materials = ExtAPI.DataModel.Project.Model.Materials

Execute a Python script file:


Import a Mechanical file and print the count of bodies:

file = r"D:\\Workdir\\bracket.mechdb"
command = f'ExtAPI.DataModel.Project.Open("{file}")'
mechanical.run_python_script("allbodies = ExtAPI.DataModel.Project.Model.GetChildren(DataModelObjectCategory.Body, True)")

Perform project-specific operations:

# Get the project directory

# List the files in the working directory

# Save

# Log in two ways:"This is a useful message.")
mechanical.log_message("INFO", "info message")

# Exit


B. Load an Embedded Instance of Mechanical in Python


Embed a Mechanical instance

Embed a mechanical instance:

from ansys.mechanical.core import App

app = App(version=232)

Extract and merge global API entry points:

# Extract the global API entry points (available from built-in Mechanical scripting)
from ansys.mechanical.core import global_variables

# Merge them into your Python global variables

Access entry points from Python:

ExtAPI    # Application.ExtAPI
DataModel    #Application.DataModel
Model    #Application.DataModel.Project.Model
Tree    #Application.DataModel.Tree 
Graphics    #Application.ExtAPI.Graphics

Import a file and print the count of bodies:

file = r"D:\\Workdir\\bracket.mechdb"
allbodies = DataModel.Project.Model.GetChildren(Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory.Body, True)

Turn on warning logging:

import logging
from ansys.mechanical.core import App
from ansys.mechanical.core.embedding.logger import (Configuration, Logger)

Configuration.configure(level=logging.WARNING, to_stdout=True)
app = App(version=232)


References from PyMechanical and Mechanical documentation