Desktop#
- class ansys.aedt.core.desktop.Desktop(*args, **kwargs)#
Provides the Ansys Electronics Desktop (AEDT) interface.
- Parameters:
- version
str
,int
,float
,optional
Version of AEDT to use. The default is
None
, in which case the active setup or latest installed version is used. Examples of input values are232
,23.2
,``2023.2``,``”2023.2”``.- 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_desktopbool,
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 isTrue
.- close_on_exitbool,
optional
Whether to close AEDT on exit. The default is
True
. This option is used only when Desktop is used in a context manager (with
statement). If Desktop is used outside a context manager, see therelease_desktop
arguments.- student_versionbool,
optional
Whether to open the AEDT student version. The default is
False
.- machine
str
,optional
Machine name to connect the oDesktop session to. This parameter 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.- port
int
,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_id
int
,optional
Process ID for the instance of AEDT to point PyAEDT at. The default is
None
. This parameter is only used whennew_desktop = False
.
- version
Examples
Launch AEDT 2023 R1 in non-graphical mode and initialize HFSS.
>>> import ansys.aedt.core >>> desktop = ansys.aedt.core.Desktop(version="2023.2", non_graphical=False) PyAEDT INFO: pyaedt v... PyAEDT INFO: Python version ... >>> hfss = ansys.aedt.core.Hfss(design="HFSSDesign1") PyAEDT INFO: Project... PyAEDT INFO: Added design 'HFSSDesign1' of type HFSS.
Launch AEDT 2023 R2 in graphical mode and initialize HFSS.
>>> desktop = Desktop(232) PyAEDT INFO: pyaedt v... PyAEDT INFO: Python version ... >>> hfss = ansys.aedt.core.Hfss(design="HFSSDesign1") PyAEDT INFO: No project is defined. Project...
Methods
Desktop.active_design
([project_object, ...])Get the active design.
Desktop.active_project
([name])Get the active project.
Desktop.analyze_all
([project, design])Analyze all setups in a project.
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.
Clear all AEDT messages.
Close all projects and shut down AEDT.
Close all windows.
Desktop.design_list
([project])Get a list of the designs.
Desktop.design_type
([project_name, design_name])Get the type of design.
Disable the autosave option.
Disable optimetrics.
Desktop.download_job_results
(job_id, ...[, ...])Download job results to a specific folder from Ansys Cloud.
Enable the autosave option.
Enable optimetrics.
Desktop.get_ansyscloud_job_info
([job_id, ...])Monitor a job submitted to Ansys Cloud.
Desktop.get_available_cloud_config
([region])Get available Ansys Cloud machines configuration.
Get toolkit ready for installation.
Check and get monitor data of an existing analysis.
Desktop.load_project
(project_file[, design_name])Open an AEDT project based on a project and optional design.
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.
Desktop.select_scheduler
(scheduler_type[, ...])Select a scheduler to submit the job.
Desktop.stop_simulations
([clean_stop])Check if there are simulation running and stops them.
Desktop.submit_ansys_cloud_job
(project_file, ...)Submit a job to be solved on a cluster.
Desktop.submit_job
(project_file, clustername)Submit a job to be solved on a cluster.
Attributes
Check if there are simulation running.
Current AEDT student version.
Current AEDT version.
Installation path for AEDT.
Dictionary of AEDT versions installed on the system and their installation paths.
AEDT logger.
Messenger manager for the AEDT logger.
AEDT instance containing all projects and designs.
PersonalLib directory.
PyAEDT directory.
Python source directory.
SysLib directory.
UserLib directory.