add_script_to_menu#
- Desktop.add_script_to_menu(toolkit_name, script_path, script_image=None, product='Project', copy_to_personal_lib=True, add_pyaedt_desktop_init=True)[source]#
Add a script to the ribbon menu.
Note
This method is available in AEDT 2023 R2 and later. PyAEDT must be installed in AEDT to allow this method to run. For more information, see Installation.
- Parameters:
- toolkit_name
str
Name of the toolkit to appear in AEDT.
- script_path
str
Full path to the script file. The script will be moved to Personal Lib.
- script_image
str
,optional
Full path to the image logo (a 30x30 pixel PNG file) to add to the UI. The default is
None
.- product
str
,optional
Product to which the toolkit applies. The default is
"Project"
, in which case it applies to all designs. You can also specify a product, such as"HFSS"
.- copy_to_personal_libbool,
optional
Whether to copy the script to Personal Lib or link the original script. Default is
True
.
- toolkit_name
- Returns: