AEDT connect session example

This example shows how to use the Common AEDT API to connect to an existing AEDT session, create a HFSS design and create a waveguide.

Perform required imports

Perform the required imports.

import sys
from ansys.aedt.toolkits.common.backend.api import AEDTCommon
from ansys.aedt.core import Desktop, settings

Initialize toolkit

Initialize the toolkit.

toolkit = AEDTCommon()

Get toolkit properties

Get the toolkit properties, which contain the project information.

properties_from_backend = toolkit.get_properties()

# ## Initialize AEDT
#
# Initialize AEDT using PyAEDT and then release it.
settings.enable_logger = False
app = Desktop(
    version=properties_from_backend["aedt_version"],
    non_graphical=properties_from_backend["non_graphical"]
)

Get AEDT sessions

Get AEDT sessions and select the first one.

sessions = toolkit.aedt_sessions()
first_key, first_value = next(iter(sessions.items()))
if first_value == -1:
    use_grpc = False
    selected_process = first_key
else:
    use_grpc = True
    selected_process = first_value

Set properties

Specify the AEDT session selection.

new_properties = {"selected_process": selected_process, "use_grpc": use_grpc}
flag, msg = toolkit.set_properties(new_properties)

INFO - Updating internal properties.

Initialize AEDT

Launch a new AEDT session in a thread.

thread_msg = toolkit.launch_thread(toolkit.launch_aedt)

INFO - AEDT is released.

Wait for the toolkit thread to be idle

Wait for the toolkit thread to be idle and ready to accept a new task.

idle = toolkit.wait_to_be_idle()
if not idle:
    print("AEDT not initialized.")
    sys.exit()

Connect design

Connect or create a new design.

toolkit.connect_design("HFSS")

INFO - Updating internal properties.
INFO - Toolkit is connected to AEDT design.

True

Get toolkit properties

Get the toolkit properties, which contain the project information.

new_properties = toolkit.get_properties()

Create a waveguide

Create a waveguide in the design.

wg = toolkit.aedtapp.modeler.create_waveguide([0, 0, 0], 1)
model = toolkit.aedtapp.plot(show=True)

C:\actions-runner\_work\pyaedt-toolkits-common\pyaedt-toolkits-common\.venv\Lib\site-packages\ansys\aedt\core\visualization\plot\pyvista.py:1402: UserWarning: Failed to use notebook backend:

Please install `nest_asyncio2` to automagically launch the trame server without await. Or, to avoid `nest_asyncio2` run:

from pyvista.trame.jupyter import launch_server
await launch_server().ready

Falling back to a static output.
  self.pv.show(auto_close=False, jupyter_backend=self.jupyter_backend)  # pragma: no cover

Save and release AEDT

Save and release AEDT.

toolkit.release_aedt(True, True)

INFO - AEDT is released.

True