Skip to content

Commit 63213cb

Browse files
Samuelopez-ansyseblanco-ansyspre-commit-ci[bot]pyansys-ci-bot
authored andcommitted
FEAT: New extension manager (#6406)
Co-authored-by: Eduardo Blanco <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: pyansys-ci-bot <[email protected]> (cherry picked from commit 2e2f96c)
1 parent ab5cf70 commit 63213cb

30 files changed

+2408
-511
lines changed

codecov.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ ignore:
22
- "src/ansys/aedt/core/rpc/*.py"
33
- "src/ansys/aedt/core/misc/*.py"
44
- "src/ansys/aedt/core/visualization/advanced/sbrplus/hdm_utils.py"
5-
- "src/ansys/aedt/core/extensions/installer"
65
- "src/ansys/aedt/core/extensions/templates"
76
- "src/ansys/aedt/core/common_rpc.py"
87
- "src/ansys/aedt/core/internal/grpc_plugin_dll_class.py"

doc/changelog.d/6406.added.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
New extension manager

doc/source/Getting_started/Installation.rst

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,15 @@ If you have installation problems, visit :ref:`Troubleshooting<panel_error>`.
4949
Extension manager
5050
~~~~~~~~~~~~~~~~~
5151

52-
The user can install or uninstall automated workflows using the extension manager.
53-
There are three options:
52+
The **PyAEDT Extension Manager** provides a centralized interface for accessing, launching, and managing automation workflows directly within AEDT.
53+
54+
From this window, you can:
55+
56+
- Browse and launch **project-level toolkits** organized by design type.
57+
- Add **custom extensions** from your local environment.
58+
- Control whether extensions appear in the **AEDT Automation ribbon** for quick access.
59+
60+
There are three types of extensions supported:
5461

5562
- **Pre-installed extensions** already available in the PyAEDT library.
5663

@@ -64,13 +71,27 @@ See `Extension Manager <https://aedt.docs.pyansys.com/version/stable/User_guide/
6471
:width: 800
6572
:alt: PyAEDT toolkit manager 1
6673

67-
The user can select the AEDT application to install the specific workflow.
74+
Each extension tile shows its name, icon, and a **Launch** button.
75+
Extensions that are not currently linked to the AEDT ribbon show a muted icon.
76+
Pinned extensions are marked and appears in the corresponding AEDT design ribbon tab.
77+
78+
79+
Selecting the **Custom** tile in the Extension Manager opens a dialog where you can add your own PyAEDT-based extension.
6880

6981
.. image:: ../Resources/toolkit_manager_2.png
7082
:width: 400
7183
:alt: PyAEDT toolkit manager 2
7284

73-
Once the toolkit is installed, its icon only appears in the ribbon when you either create a new design or open an existing one that is compatible with the toolkit. Toolkit icons are visible only within the corresponding design environment.
85+
In the dialog, you can:
86+
87+
- **Browse for a Python script** that implements the extension behavior.
88+
- **Optionally leave the script path empty**. If no script is provided, a default extension script is automatically generated using a predefined template.
89+
90+
You must also specify an **Extension Name**, which appears in the AEDT Automation.
91+
92+
Once configured, click **OK** to register the extension. It then appears alongside other extensions in the manager interface.
93+
94+
A message bar at the bottom provides real-time feedback about actions, such as launching extensions or errors.
7495

7596
For additional information about AEDT extensions,
7697
see `Extensions <https://aedt.docs.pyansys.com/version/stable/User_guide/extensions.html>`_.
-67.9 KB
Binary file not shown.
52.5 KB
Loading
12.5 KB
Loading
-7.4 KB
Binary file not shown.

doc/source/User_guide/extensions.rst

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -284,30 +284,24 @@ Here are some links to existing toolkits:
284284
Now, you need to download the installer from the Releases section of each toolkit.
285285
You can access it by clicking the "Install" button in the corresponding repository.
286286

287-
After installing it, you can add the toolkit to AEDT as a Custom extension by pointing to the .exe file.
288-
289-
.. image:: ../Resources/toolkit_manager_3.png
290-
:width: 500
291-
:alt: PyAEDT toolkit manager 3
292-
293287

294288
Custom extensions
295289
-----------------
296290

297291
Custom extensions are custom workflows (Python script) that can be installed both at project and application level.
298-
From the Extension manager select the target destination:
292+
From the Extension manager select the target destination and `Custom` as the extension type:
299293

300294
.. image:: ../Resources/toolkit_manager_1.png
301295
:width: 500
302296
:alt: PyAEDT toolkit manager 1
303297

304-
Select `Custom` as the extension type.
305-
Provide the path of the Python script containing the workflow.
298+
Provide the path of the Python script containing the workflow. If you do not specify any script, the template is assigned.
299+
306300
Enter the extension name. This is the name that appears beneath the button in the Automation tab after a successful installation.
307301

308-
.. image:: ../Resources/my_custom_extension.png
302+
.. image:: ../Resources/toolkit_manager_2.png
309303
:width: 500
310-
:alt: Custom Extension
304+
:alt: PyAEDT toolkit manager 2
311305

312306
After the normal completion of the installation a new button appears:
313307

src/ansys/aedt/core/extensions/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,7 @@
2121
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2222
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2323
# SOFTWARE.
24+
25+
from pathlib import Path
26+
27+
EXTENSIONS_PATH = Path(__file__).parent

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ script = "import_schematic.py"
44
icon = "images/large/schematic.png"
55
template = "run_pyaedt_toolkit_script"
66
pip = ""
7+
url = "https://aedt.docs.pyansys.com/version/stable/User_guide/pyaedt_extensions_doc/circuit/import_schematic.html"
78

89
[CircuitConfiguration]
910
name = "Circuit Configuration"
1011
script = "circuit_configuration.py"
1112
icon = "images/large/circuit_config.png"
1213
template = "run_pyaedt_toolkit_script"
1314
pip = ""
15+
url = "https://aedt.docs.pyansys.com/version/stable/User_guide/pyaedt_extensions_doc/circuit/circuit_configuration.html"
1416

0 commit comments

Comments
 (0)