DOCS: Add extensions documentation (#4850)

Co-authored-by: Devin <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>

Author: 3 people

doc/source/Getting_started/Installation.rst

@@ -65,6 +65,9 @@ The user can select the AEDT application to install the specific workflow.
   :width: 400
   :alt: PyAEDT toolkit manager 2
 
+For additional information about AEDT extensions, 
+see `Extensions <https://aedt.docs.pyansys.com/version/stable/User_guide/extensions.html>`_.
+
 
 Install on CPython from PyPI
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/Resources/toolkits_ribbon.png

@@ -0,0 +1,36 @@
+Extensions
+==========
+
+Extensions provide a simplified interface to perform automated workflows in AEDT.
+In AEDT, you can use the Extension Manager to add or remove extensions.
+For more information, see `Extension Manager <https://aedt.docs.pyansys.com/version/stable/Getting_started/Installation.html#extension-manager>`_.
+
+Extensions are generally tool-specific and are therefore only accessible given the appropriate context. The following sections provide further clarification.
+
+You can launch extensions in standalone mode from the console or a Python script.
+
+Project extensions
+==================
+
+Project extension apply to all extensions that are applicable for all AEDT applications.
+
+.. grid:: 2
+
+   .. grid-item-card:: Import Nastran
+            :link: pyaedt_extensions_doc/project
+            :link-type: doc
+
+            Import a Nastran or STL file in any 3D modeler application.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   pyaedt_extensions_doc/project
+
+HFSS extensions
+===============
+
+
+HFSS 3D Layout extensions
+=========================

doc/source/User_guide/extensions.rst

@@ -18,6 +18,13 @@ For end-to-end examples, see `Examples <https://aedt.docs.pyansys.com/version/st
 
             How to launch AEDT and create a project.
 
+   .. grid-item-card:: Extensions
+            :link: extensions
+            :link-type: doc
+            :margin: 2 2 0 0
+
+            How to use PyAEDT extensions.
+
    .. grid-item-card:: Modeler
             :link: modeler
             :link-type: doc
@@ -72,6 +79,7 @@ For end-to-end examples, see `Examples <https://aedt.docs.pyansys.com/version/st
    :maxdepth: 2
 
    intro
+   extensions
    modeler
    mesh
    setup

doc/source/User_guide/index.rst

@@ -0,0 +1,51 @@
+Import Nastran
+==============
+
+You can import a Nastran or STL file in any 3D modeler. You can also preview the imported file and decimate it prior to import.
+
+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:: import_nastran_ui.png
+  :width: 800
+  :alt: Import Nastran UI
+
+You can also launch the extension user interface from the terminal:
+
+.. code::
+
+   SET PYAEDT_SCRIPT_PORT=50051
+   SET PYAEDT_SCRIPT_VERSION=2024.1
+   python.exe path/to/pyaedt/workflows/project/import_nastran.py
+
+The available arguments are: ``file_path``, ``planar``, ``lightweight``, and ``decimate``.
+You can obtain these arguments from the help with this command:
+
+.. code::
+
+   python.exe path/to/pyaedt/workflows/project/import_nastran.py --help
+
+This code shows how to pass the input file as an argument, which doesn't launch the user interface:
+
+.. code::
+
+   export PYAEDT_SCRIPT_PORT=50051
+   export PYAEDT_SCRIPT_VERSION=2024.1
+   python.exe path/to/pyaedt/workflows/project/import_nastran.py --file_path="my_file.stl"
+
+Finally, this code shows how you can run the extension directly from a Python script:
+
+.. code:: python
+
+    import pyaedt
+    import os
+    from pyaedt.workflows.project.import_nastran import main
+    file_path = "my_file.stl"
+    hfss = pyaedt.Hfss()
+    # Specify the AEDT session to connect
+    os.environ["PYAEDT_SCRIPT_PORT"] = str(hfss.desktop_class.port)
+    os.environ["PYAEDT_SCRIPT_VERSION"] = hfss.desktop_class.aedt_version_id
+    # Launch extension
+    main({"file_path": file_path, "lightweight": True, "decimate": 0.0, "planar": True, "is_test": False})
+

doc/source/User_guide/pyaedt_extensions_doc/import_nastran_ui.png

@@ -30,6 +30,7 @@ efields
 EMIT
 FEBI
 FE-BI
+file_path
 getters
 globals
 [Gg]gRPC
@@ -47,6 +48,7 @@ Maxwell Circuit
 multiphysics
 multiplot
 namespaces
+Nastran
 netlist
 Nexxim
 numpy