REFACTOR: Extension manager compatible with toolkits (#6115)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Giulia Malinverno <[email protected]>

Author: 4 people

doc/changelog.d/6115.miscellaneous.md

@@ -0,0 +1 @@
+Extension manager compatible with toolkits

doc/source/Getting_started/Installation.rst

@@ -46,6 +46,7 @@ Starting from 2023R2, buttons are available in the Automation Tab as in the exam
 
 Extension manager
 ~~~~~~~~~~~~~~~~~
+
 The user can install or uninstall automated workflows using the extension manager.
 There are three options:
 

doc/source/Getting_started/Troubleshooting.rst

@@ -54,6 +54,31 @@ Another option to install PyAEDT from the wheelhouse is to download the followin
 Run this script directly from AEDT and pass the wheelhouse file name as an argument.
 
 
+Error installing PyAEDT panels in AEDT
+--------------------------------------
+
+Sometimes, the PyAEDT installer may fail when adding panels to AEDT.
+
+This is typically caused by insufficient write permissions to your PersonalLib directory.
+
+.. image:: ../Resources/toolkit_manager_3.png
+  :width: 800
+  :alt: PyAEDT toolkit manager 3
+
+If the virtual environment was successfully created, you can first activate it, and then you manually register the toolkit panels using the following command:
+
+.. code::
+
+     from ansys.aedt.core.extensions.installer.pyaedt_installer import add_pyaedt_to_aedt
+     add_pyaedt_to_aedt(“your_aedt_version", r“path_to_personalib")
+
+If you need to restart the setup from scratch, follow these steps:
+
+- Delete the virtual environment folder. On Windows: located in your APPDATA directory. On Linux: located in your HOME directory.
+
+- Delete the Toolkits directory in your PersonalLib folder.
+
+These steps remove any existing configurations and allow you to perform a clean installation.
 
 
 Run PyAEDT

doc/source/Resources/toolkit_manager_2.png

@@ -1,5 +1,5 @@
-Extension manager
-=================
+Extensions
+==========
 
 Extensions provide a simplified graphical user interface (GUI) to perform automated workflows in AEDT, they are generally tool-specific and are therefore only accessible given the appropriate context.
 In AEDT, you can use the `Extension manager <https://aedt.docs.pyansys.com/version/stable/Getting_started/Installation.html#extension-manager>`_ to add or remove extensions.
@@ -267,6 +267,15 @@ Here are some links to existing toolkits:
 - Hfss: `Antenna Wizard <https://github.com/ansys/pyaedt-toolkits-antenna>`_.
 - Maxwell 3D: `Magnet Segmentation Wizard <https://github.com/ansys/magnet-segmentation-toolkit>`_.
 
+Now, you need to download the installer from the Releases section of each toolkit.
+You can access it by clicking the "Install" button in the corresponding repository.
+
+After installing it, you can add the toolkit to AEDT as a Custom extension by pointing to the .exe file.
+
+.. image:: ../Resources/toolkit_manager_3.png
+  :width: 500
+  :alt: PyAEDT toolkit manager 3
+
 
 Custom extensions
 -----------------

doc/source/Resources/toolkit_manager_3.png

@@ -7,8 +7,6 @@ with the use of a simple script.
 
 This script is compatible with AEDT files, as well as A3DCOMP files (including encrypted 3DComponents).
 
-You can access the extension from the icon created on the **Automation** tab using the Extension Manager.
-
 The following image shows the extension user interface:
 
 .. image:: ../../../_static/extensions/kernel_convert_ui.png
@@ -39,7 +37,7 @@ the generated 2025R1 version (with the Parasolid Kernel) files.
   :width: 800
   :alt: Generated Files During Kernel Conversion
 
-You can also launch the extension user interface from the terminal:
+You can launch the extension user interface from the terminal, you can find the script in the PyAEDT installation:
 
 .. code::
 

doc/source/User_guide/extensions.rst

@@ -4,7 +4,8 @@ PyAEDT documentation  |version|
 **Useful links**:
 `Installation <https://aedt.docs.pyansys.com/version/stable/Getting_started/Installation.html>`_ |
 `Source Repository <https://github.com/ansys/pyaedt>`_ |
-`Issues <https://github.com/ansys/pyaedt/issues>`_
+`Issues <https://github.com/ansys/pyaedt/issues>`_ |
+`Extensions <https://aedt.docs.pyansys.com/version/stable/User_guide/extensions.html>`_
 
 .. figure:: _static/logo.png
     :align: center

doc/source/User_guide/pyaedt_extensions_doc/project/kernel_convert.rst

@@ -3,4 +3,3 @@ name = "Schematic Importer"
 script = "import_schematic.py"
 icon = "images/large/schematic.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""

doc/source/index.rst

@@ -1,42 +1,27 @@
 [AntennaWizard]
-name = "Antenna Wizard"
-script = "ansys/aedt/toolkits/antenna/run_toolkit.py"
-icon = "images/large/antenna.png"
-template = "run_pyaedt_toolkit_script"
-pip = "ansys-aedt-toolkits-antenna"
-package = "ansys.aedt.toolkits.antenna"
+name = "Antenna Toolkit"
+url = "https://aedt.antenna.toolkit.docs.pyansys.com/version/stable/getting_started/installation.html"
 
 [PushfromTransient]
 name = "Push Excitation from transient data"
 script = "push_excitation_from_file.py"
 icon = "images/large/push.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
-
-[PointCloudGenerator]
-name = "Point Cloud Generator"
-script = "points_cloud.py"
-icon = "images/large/cloud.png"
-template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [ChokeDesigner]
 name = "Choke Designer"
 script = "choke_designer.py"
 icon = "images/large/choke.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [ShieldingEffectiveness]
 name = "Shielding Effectiveness"
 script = "shielding_effectiveness.py"
 icon = "images/large/shielding.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [MoveIt]
 name = "Move It"
 script = "move_it.py"
 icon = "images/large/move_it.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""

src/ansys/aedt/core/extensions/circuit/toolkits_catalog.toml

@@ -3,53 +3,45 @@ name = "Export to 3D"
 script = "export_to_3d.py"
 icon = "images/large/cad3d.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [PushfromTransient]
 name = "Push Excitation from transient data"
 script = "push_excitation_from_file_3dl.py"
 icon = "images/large/push.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [ExportFiles]
 name = "Export Layout info"
 script = "export_layout.py"
 icon = "images/large/export.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [Cutout]
 name = "Advanced cutout"
 script = "cutout.py"
 icon = "images/large/cutout.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [Parametrize]
 name = "Parametrize layout"
 script = "parametrize_edb.py"
 icon = "images/large/parametrize.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [ArbitraryWaveport]
 name = "Arbitrary Waveports"
 script = "generate_arbitrary_wave_ports.py"
 icon = "images/large/arbitrary_wave_port.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [ViaClustering]
 name = "Via merging"
 script = "via_clustering_extension.py"
 icon = "images/large/via_merging.png"
 template = "run_pyaedt_toolkit_script"
-pip = ""
 
 [PostLayoutDesignToolkit]
 name = "Post Layout Design Toolkit"
 script = "post_layout_design_toolkit.py"
 icon = "images/large/post_layout_design_toolkit.png"
-template = "run_pyaedt_toolkit_script"
-pip = ""
+template = "run_pyaedt_toolkit_script"

src/ansys/aedt/core/extensions/hfss/images/large/antenna.png

@@ -2,5 +2,4 @@
 name = "Create Power Map from CSV file"
 script = "power_map_from_csv.py"
 icon = "images/large/push.png"
-template = "run_pyaedt_toolkit_script"
-pip = ""
+template = "run_pyaedt_toolkit_script"