pyaedt.desktop.Desktop#

class pyaedt.desktop.Desktop(specified_version=None, non_graphical=False, new_desktop_session=True, close_on_exit=True, student_version=False, machine='', port=0, aedt_process_id=None)[source]#

Provides the Ansys Electronics Desktop (AEDT) interface.

Parameters:
specified_versionstr, optional

Version of AEDT to use. The default is None, in which case the active setup or latest installed version is used.

non_graphicalbool, optional

Whether to launch AEDT in non-graphical mode. The default is False, in which case AEDT is launched in graphical mode. This parameter is ignored when a script is launched within AEDT.

new_desktop_sessionbool, optional

Whether to launch an instance of AEDT in a new thread, even if another instance of the specified_version is active on the machine. The default is True.

close_on_exitbool, optional

Whether to close AEDT on exit. The default is True.

student_versionbool, optional

Whether to open the AEDT student version. The default is False.

machinestr, optional

Machine name to connect the oDesktop session to. This parameters works only in 2022 R2 and later. The remote server must be up and running with the command “ansysedt.exe -grpcsrv portnum”. If the machine is “localhost”, the server also starts if not present.

portint, optional

Port number on which to start the oDesktop communication on the already existing server. This parameter is ignored when creating a new server. It works only in 2022 R2 and later. The remote server must be up and running with the command “ansysedt.exe -grpcsrv portnum”.

aedt_process_idint, optional

Process ID for the instance of AEDT to point PyAEDT at. The default is None. This parameter is only used when new_desktop_session = False.

Examples

Launch AEDT 2021 R1 in non-graphical mode and initialize HFSS.

>>> import pyaedt
>>> desktop = pyaedt.Desktop("2021.2", non_graphical=True)
pyaedt INFO: pyaedt v...
pyaedt INFO: Python version ...
>>> hfss = pyaedt.Hfss(designname="HFSSDesign1")
pyaedt INFO: Project...
pyaedt INFO: Added design 'HFSSDesign1' of type HFSS.

Launch AEDT 2021 R1 in graphical mode and initialize HFSS.

>>> desktop = Desktop("2021.2")
pyaedt INFO: pyaedt v...
pyaedt INFO: Python version ...
>>> hfss = pyaedt.Hfss(designname="HFSSDesign1")
pyaedt INFO: No project is defined. Project...

Methods

Desktop.analyze_all([project, design])

Analyze all setups in a project.

Desktop.change_active_dso_config_name([...])

Change a specific registry key to a new value.

Desktop.change_license_type([license_type])

Change the license type.

Desktop.change_registry_from_file(registry_file)

Apply desktop registry settings from an ACF file.

Desktop.change_registry_key(key_full_name, ...)

Change an AEDT registry key to a new value.

Desktop.clear_messages()

Clear all AEDT messages.

Desktop.close_desktop()

Close all projects and shut down AEDT.

Desktop.copy_design([project_name, ...])

Copy a design and paste it in an existing project or new project.

Desktop.design_list([project])

Get a list of the designs.

Desktop.design_type([project_name, design_name])

Get the type of a design.

Desktop.disable_autosave()

Disable the autosave option.

Desktop.enable_autosave()

Enable the autosave option.

Desktop.force_close_desktop()

Forcibly close all projects and shut down AEDT.

Desktop.project_list()

Get a list of projects.

Desktop.project_path([project_name])

Get the path to the project.

Desktop.release_desktop([close_projects, ...])

Release AEDT.

Desktop.save_project([project_name, ...])

Save the project.

Attributes

Desktop.aedt_version_id

AEDT version.

Desktop.current_version

Current AEDT version.

Desktop.current_version_student

Current student AEDT version.

Desktop.install_path

Installation path for AEDT.

Desktop.logger

AEDT logger.

Desktop.messenger

Messenger manager for the AEDT logger.

Desktop.personallib

PersonalLib directory.

Desktop.pyaedt_dir

PyAEDT directory.

Desktop.src_dir

Python source directory.

Desktop.syslib

SysLib directory.

Desktop.userlib

UserLib directory.

Desktop.version_keys

Version keys for AEDT.