Skip to content
SVD AI Lab docs

Ansys Mechanical plugin for sim-cli

Drive Ansys Mechanical from Codex, Claude Code, and other local AI coding agents through sim-cli.

What you can do

Section titled “What you can do”
  • Open a live, observable session — Mechanical launches with its GUI window visible, so an agent can act on the model and a human can watch the same window.
  • Send Python snippets to the live model — apply geometry edits, materials, mesh controls, loads, boundary conditions, solves, and result extraction one snippet at a time, without leaving the session.
  • Visual verification — uv run sim screenshot captures the live Mechanical window so an agent can confirm what the model actually looks like between steps, even when other windows are in the foreground.
  • Inspect model state — structured queries return parts, geometry, materials, and result quantities for an agent to reason over.
  • Headless mode — for CI / batch use, launch without a GUI window. Snippet execution and inspection still work; visual probes don’t.

Install

Section titled “Install”
Terminal window
uv init  # only if this is not already a uv project
uv add sim-cli-core sim-plugin-mechanical
uv run sim plugin sync-skills --target .agents/skills --copy   # Codex / Copilot
uv run sim plugin sync-skills --target .claude/skills --copy   # Claude Code
uv run sim check mechanical
uv run sim plugin doctor mechanical --deep

Quick start

Section titled “Quick start”
Terminal window
uv run sim connect --solver mechanical --mode mechanical --ui-mode gui
uv run sim exec '<your Mechanical Python snippet>'
uv run sim screenshot
uv run sim inspect session.summary
uv run sim disconnect

Headless variant:

Terminal window
uv run sim connect --solver mechanical --mode mechanical --ui-mode no_gui

Prerequisites

Section titled “Prerequisites”
  • A licensed Ansys Mechanical installation on the host
  • Python 3.10+ and uv on the same machine

Not the same as abaqus or workbench

Section titled “Not the same as abaqus or workbench”

Use this plugin for Ansys Mechanical workflows specifically. For Dassault SIMULIA Abaqus see abaqus; for Ansys Workbench project orchestration (which can hand work off to Mechanical) see workbench.

Source

Section titled “Source”