pyaedt

What it is and what it does

PyAEDT is a Python wrapper around the Ansys Electronics Desktop API that simplifies scripting and automation of electromagnetic, thermal, and mechanical simulations. Instead of using AEDT's native scripting language or low-level API calls, developers write clean Python code to set up projects, run solvers, and extract results across HFSS, Maxwell, Icepak, Q3D Extractor, Mechanical, Nexxim, and other AEDT tools.

The library handles initialization, error management, logging, and variable management automatically, making it practical for both one-off automation tasks and reusable simulation frameworks. It works both inside AEDT's IronPython environment and as a standalone CPython application, automatically detecting the runtime and initializing accordingly. PyAEDT also includes pyedb as a dependency for programmatic PCB layout and package manipulation.

Use it for:

• Automate repetitive AEDT design tasks (geometry creation, boundary setup, solver configuration) across multiple projects.
• Build CI/CD pipelines that run electromagnetic or thermal simulations and extract results without manual UI interaction.
• Develop reusable simulation templates and parameter sweeps for design optimization across HFSS, Maxwell, or Icepak.
• Programmatically manipulate PCB layouts, electronic packages, and integrated circuit designs via the included EDB interface.
• Generate clean, maintainable simulation scripts from recorded AEDT macros for team collaboration and version control.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

PyAEDT provides a Python API to script and automate Ansys Electronics Desktop (AEDT), including its 3D solvers (HFSS, Maxwell, Icepak, Q3D), 2D tools, circuit simulators, and layout tools.

Yes, if you have a licensed copy of AEDT and need to automate simulations or design workflows. The library is actively maintained, has no known vulnerabilities, uses a permissive MIT license, and supports current Python versions. The main constraint is the hard dependency on a local AEDT installation—it is not useful without it.

Install

pyaedt on PyPI

pip install pyaedt

uv add pyaedt

poetry add pyaedt

Installing pyaedt

Before you install

Low install friction with a pure-wheel distribution. Active maintenance with a release 1 day old and recent commits. Supports modern Python versions 3.10 through 3.14.

License in practice

MIT license permits commercial and private use with minimal restrictions, making it suitable for most professional and research environments.

Quickstart

pip install pyaedt

from pyaedt import Desktop

desktop = Desktop(version="2025.1", non_graphical=False)
app = desktop.new_hfss()
# Interact with AEDT via app object

Requires a local licensed copy of Ansys Electronics Desktop (AEDT 2022 R1 or newer); cannot run without AEDT installed and a valid license.

Verify before relying

• Whether the [all] extra installation (which includes fpdf2 under LGPL v3) is commonly used and what its practical license implications are for users.
• Performance characteristics when scripting large or complex AEDT projects.
• Stability and compatibility across the full range of AEDT versions claimed (2022 R1 and newer).

Package facts

Evidence: pyaedt-1.4.0-py3-none-any.whl

Tags

More Libraries packages