diff --git a/doc/changelog.d/8008.documentation.md b/doc/changelog.d/8008.documentation.md new file mode 100644 index 000000000000..e9dc6b22c30f --- /dev/null +++ b/doc/changelog.d/8008.documentation.md @@ -0,0 +1 @@ +Fixed links and created missing docs diff --git a/doc/source/User_guide/extensions.rst b/doc/source/User_guide/extensions.rst index 1bcd81d08f6b..1d29eb600a68 100644 --- a/doc/source/User_guide/extensions.rst +++ b/doc/source/User_guide/extensions.rst @@ -29,51 +29,47 @@ They are small automated workflows with a simple GUI. .. grid:: 2 - .. grid-item-card:: Import Nastran - :link: pyaedt_extensions_doc/project/import_nastran + .. grid-item-card:: Generate Report + :link: pyaedt_extensions_doc/project/generate_report :link-type: doc :margin: 2 2 0 0 - Import a Nastran or STL file in any 3D modeler application. - + Create a PDF report from the plots in the active AEDT design. - .. grid-item-card:: Configure Layout - :link: pyaedt_extensions_doc/project/configure_layout + .. grid-item-card:: Result Calculator + :link: pyaedt_extensions_doc/project/result_calculator :link-type: doc :margin: 2 2 0 0 - Configure layout for PCB & package analysis. + Collect, plot and manage result traces. + +Shared extensions +~~~~~~~~~~~~~~~~~ +Shared extensions are available in the AEDT applications supported by each extension. - .. grid-item-card:: Advanced Fields Calculator - :link: pyaedt_extensions_doc/project/advanced_fields_calculator +.. grid:: 2 + + .. grid-item-card:: Import Nastran + :link: pyaedt_extensions_doc/project/import_nastran :link-type: doc :margin: 2 2 0 0 - Lear how to use the Advanced Fields Calculator extension. - + Import a Nastran or STL file in supported 3D modeler applications. - .. grid-item-card:: Kernel converter - :link: pyaedt_extensions_doc/project/kernel_convert + .. grid-item-card:: Advanced Fields Calculator + :link: pyaedt_extensions_doc/project/advanced_fields_calculator :link-type: doc :margin: 2 2 0 0 - Lear how to convert projects from 2022R2 to newer versions. - + Use the Advanced Fields Calculator in supported AEDT applications. .. grid-item-card:: Point cloud generator :link: pyaedt_extensions_doc/project/point_cloud_generator :link-type: doc :margin: 2 2 0 0 - Generate and import points list from a geometry. - - .. grid-item-card:: Via design - :link: pyaedt_extensions_doc/project/via_design - :link-type: doc - :margin: 2 2 0 0 - - Generate a parameterized via design. + Generate and import points from geometry in supported AEDT applications. HFSS 3D Layout extensions ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -90,6 +86,12 @@ They are small automated workflows with a simple GUI. Parametrize a full layout design. + .. grid-item-card:: Configure Layout + :link: pyaedt_extensions_doc/project/configure_layout + :link-type: doc + :margin: 2 2 0 0 + + Configure layout for PCB and package analysis. .. grid-item-card:: Generate arbitrary wave ports :link: pyaedt_extensions_doc/hfss3dlayout/arbitrary_wave_port @@ -105,6 +107,13 @@ They are small automated workflows with a simple GUI. Edit a source from file data in HFSS 3D Layout. + .. grid-item-card:: Via design + :link: pyaedt_extensions_doc/project/via_design + :link-type: doc + :margin: 2 2 0 0 + + Generate a parameterized via design. + .. grid-item-card:: Cutout :link: pyaedt_extensions_doc/hfss3dlayout/cutout :link-type: doc @@ -239,6 +248,21 @@ They are small automated workflows with a simple GUI. Convert Twin Builder design to Circuit. +Q3D extensions +~~~~~~~~~~~~~~ + +Pre-installed extensions are available at Q3D level. +They are small automated workflows with a simple GUI. + +.. grid:: 2 + + .. grid-item-card:: Harmonic Loss Input + :link: pyaedt_extensions_doc/q3d/harmonic_loss + :link-type: doc + :margin: 2 2 0 0 + + Import and configure harmonic-loss source data for a Q3D design. + Maxwell extensions ~~~~~~~~~~~~~~~~~~ @@ -305,6 +329,7 @@ Templates to show how to build an extension consisting of a small automated work pyaedt_extensions_doc/icepak/index pyaedt_extensions_doc/circuit/index pyaedt_extensions_doc/twinbuilder/index + pyaedt_extensions_doc/q3d/index pyaedt_extensions_doc/maxwell/index pyaedt_extensions_doc/emit/index pyaedt_extensions_doc/templates/index diff --git a/doc/source/User_guide/pyaedt_extensions_doc/project/generate_report.rst b/doc/source/User_guide/pyaedt_extensions_doc/project/generate_report.rst new file mode 100644 index 000000000000..5a33d38f9703 --- /dev/null +++ b/doc/source/User_guide/pyaedt_extensions_doc/project/generate_report.rst @@ -0,0 +1,31 @@ +Generate report +=============== + +The Generate Report extension creates a PDF report for the active AEDT design. +The generated report includes the design results currently available as plots in AEDT. + +How to use +========== + +1. Open the AEDT project and design whose plots you want to include in the report. +2. In the Extension Manager, select **Generate report**. +3. Enter a report name. +4. Optionally, select a folder in which to save the PDF. If no folder is selected, the PDF is saved in the design working directory. +5. Select **Open report after generation** to open the PDF automatically on Windows. +6. Click **Generate Report**. + +The extension creates a PDF with a table of contents and a section containing the plots available in the active design. + +Output +====== + +The generated file is named ``.pdf``. The AEDT message manager reports the full path after the report is created. + +API usage example +================= + +The extension is launched from AEDT using the PyAEDT Extension Manager. You can also run it standalone: + +.. code:: bash + + python create_report.py diff --git a/doc/source/User_guide/pyaedt_extensions_doc/project/index.rst b/doc/source/User_guide/pyaedt_extensions_doc/project/index.rst index de901a53130c..296680d5fb47 100644 --- a/doc/source/User_guide/pyaedt_extensions_doc/project/index.rst +++ b/doc/source/User_guide/pyaedt_extensions_doc/project/index.rst @@ -3,6 +3,13 @@ Project extensions .. grid:: 2 + .. grid-item-card:: Generate Report + :link: generate_report + :link-type: doc + :margin: 2 2 0 0 + + Create a PDF report from the plots in the active AEDT design. + .. grid-item-card:: Import Nastran :link: import_nastran :link-type: doc diff --git a/src/ansys/aedt/core/extensions/common/toolkits_catalog.toml b/src/ansys/aedt/core/extensions/common/toolkits_catalog.toml index 818e824a2953..eec0c05a3824 100644 --- a/src/ansys/aedt/core/extensions/common/toolkits_catalog.toml +++ b/src/ansys/aedt/core/extensions/common/toolkits_catalog.toml @@ -1,12 +1,14 @@ [GenerateReport] # All icon = "images/large/pdf.png" name = "Generate report" -script = "create_report.py" optional = true +script = "create_report.py" template = "run_pyaedt_toolkit_script" +url = "https://aedt.docs.pyansys.com/version/stable/User_guide/pyaedt_extensions_doc/project/generate_report.html" [ResultCalculator] icon = "images/large/result_calculator.png" name = "Result Calculator" script = "result_calculator.py" template = "run_pyaedt_toolkit_script" +url = "https://aedt.docs.pyansys.com/version/stable/User_guide/pyaedt_extensions_doc/project/result_calculator.html"