Application and solvers

The PyAEDT API includes classes for different applications available in Ansys Electronics Desktop (AEDT). You must initialize AEDT to get access to all PyAEDT modules and methods.

Available PyAEDT apps are:

pyaedt.desktop.Desktop(*args, **kwargs)	Provides the Ansys Electronics Desktop (AEDT) interface.
pyaedt.hfss.Hfss([projectname, designname, ...])	Provides the HFSS application interface.
pyaedt.q3d.Q3d([projectname, designname, ...])	Provides the Q3D app interface.
pyaedt.q3d.Q2d([projectname, designname, ...])	Provides the Q2D app interface.
pyaedt.maxwell.Maxwell2d([projectname, ...])	Provides the Maxwell 2D app interface.
pyaedt.maxwell.Maxwell3d([projectname, ...])	Provides the Maxwell 3D app interface.
pyaedt.icepak.Icepak([projectname, ...])	Provides the Icepak application interface.
pyaedt.hfss3dlayout.Hfss3dLayout([...])	Provides the HFSS 3D Layout application interface.
pyaedt.mechanical.Mechanical([projectname, ...])	Provides the Mechanical application interface.
pyaedt.rmxprt.Rmxprt([projectname, ...])	Provides the RMxprt app interface.
pyaedt.circuit.Circuit([projectname, ...])	Provides the Circuit application interface.
pyaedt.maxwellcircuit.MaxwellCircuit([...])	Provide the Maxwell Circuit application interface.
pyaedt.emit.Emit([projectname, designname, ...])	Provides the EMIT application interface.
pyaedt.twinbuilder.TwinBuilder([...])	Provides the Twin Builder application interface.

All other classes and methods are inherited into the app class. AEDT, which is also referred to as the desktop app, is implicitly launched in any PyAEDT app. Before accessing a PyAEDT app, the desktop app must be launched and initialized. The desktop app can be explicitly or implicitly initialized as in the following examples.

Example with Desktop class explicit initialization:

from pyaedt import launch_desktop, Circuit
d = launch_desktop(specified_version="2023.1",
                   non_graphical=False,
                   new_desktop_session=True,
                   close_on_exit=True,
                   student_version=False):
 circuit = Circuit()
 ...
 # Any error here will be caught by Desktop.
 ...
 d.release_desktop()

Example with Desktop class implicit initialization:

from pyaedt import Circuit
circuit = Circuit(specified_version="2023.1",
                  non_graphical=False,
                  new_desktop_session=True,
                  close_on_exit=True,
                  student_version=False):
 circuit = Circuit()
 ...
 # Any error here will be caught by Desktop.
 ...
 circuit.release_desktop()