pyaedt.Desktop#

class pyaedt.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]#

Initializes AEDT based on the inputs provided.

Note

On Windows, this class works without limitations in IronPython and CPython. On Linux, this class works only in embedded IronPython in AEDT.

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 which connect the oDesktop Session. Works only on 2022R2. Remote Server must be up and running with command “ansysedt.exe -grpcsrv portnum”. If machine is “localhost” the server will also start if not present.

portint, optional

Port number of which start the oDesktop communication on already existing server. This parameter is ignored in new server creation. It works only on 2022R2. Remote Server must be up and running with command “ansysedt.exe -grpcsrv portnum”.

aedt_process_idint, optional

Only used when new_desktop_session = False, specifies by process ID which instance of Electronics Desktop to point PyAEDT at.

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])

Retrieve a list of the designs.

Desktop.design_type([project_name, design_name])

Retrieve 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()

Retrieve a list of projects.

Desktop.project_path([project_name])

Retrieve 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.