The ui.py module#

Summary#

UILauncher

Launch the GUI using a temporary mechdb file.

launch_ui

Launch the Mechanical UI.

Description#

Run Mechanical UI from Python.

Module detail#

ui.launch_ui(app: ansys.mechanical.core.embedding.App, delete_tmp_on_close: bool = True, dry_run: bool = False) → None#

Launch the Mechanical UI.

Precondition: Mechanical has to have already been saved Side effect: If Mechanical has ever been saved, it overwrites that save.

Parameters:
app: ansys.mechanical.core.embedding.app.App

A Mechanical embedding application.

delete_tmp_on_close: bool

Whether to delete the temporary mechdb file when the GUI is closed. By default, this is True.

dry_run: bool

Whether or not to launch the GUI. By default, this is False.