Download this example

Download this example as a Jupyter Notebook or as a Python script.

---

Automatic report creation

This example shows how to create reports from a JSON template file.

Keywords: Circuit, report.

Perform imports and define constants

Import the required packages. This example uses data from the example-data repository located in pyaedt\custom_reports.

import os
import tempfile
import time

import ansys.aedt.core
from IPython.display import Image

# Define constants.

AEDT_VERSION = "2024.2"
NG_MODE = False  # Open AEDT UI when it is launched.

# ## Create temporary directory
#
# Create a temporary directory where downloaded data or
# dumped data can be stored.
# If you'd like to retrieve the project data for subsequent use,
# the temporary folder name is given by ``temp_folder.name``.

temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")

# ## Launch AEDT with Circuit
#
# AEDT is started by instantiating an instance of
# [pyaedt.Circuit](https://aedt.docs.pyansys.com/version/stable/API/_autosummary/pyaedt.circuit.Circuit.html).
#
# ### Application keyword arguments
#
# - The argument ``non_graphical`` specifies whether an interactive session is launched or if
#   AEDT is to run in non-graphical mode.
# - The Boolean parameter ``new_desktop`` specifies if a new instance
#   of AEDT is launched. If it is set to ``False``, the API tries to connect to a running session.
#
# This example extracts an archived project. The full path
# to the extracted project is accessible from the ``cir.project_file`` property.

project_path = ansys.aedt.core.downloads.download_file(
    source="custom_reports/", destination=temp_folder.name
)

circuit = ansys.aedt.core.Circuit(
    project=os.path.join(project_path, "CISPR25_Radiated_Emissions_Example23R1.aedtz"),
    non_graphical=NG_MODE,
    version=AEDT_VERSION,
    new_desktop=True,
)
circuit.analyze()  # Run the circuit analysis.

PyAEDT INFO: Python version 3.10.11 (tags/v3.10.11:7d4cc5a, Apr  5 2023, 00:38:17) [MSC v.1929 64 bit (AMD64)]
PyAEDT INFO: PyAEDT version 0.12.dev0.
PyAEDT INFO: Initializing new Desktop session.
PyAEDT INFO: Log on console is enabled.
PyAEDT INFO: Log on file C:\Users\ansys\AppData\Local\Temp\pyaedt_ansys_da424de2-5102-4e69-ac66-8647d0d2f369.log is enabled.
PyAEDT INFO: Log on AEDT is enabled.
PyAEDT INFO: Debug logger is disabled. PyAEDT methods will not be logged.
PyAEDT INFO: Launching PyAEDT with gRPC plugin.
PyAEDT INFO: New AEDT session is starting on gRPC port 55140
PyAEDT INFO: AEDT installation Path C:\Program Files\AnsysEM\v242\Win64
PyAEDT INFO: Ansoft.ElectronicsDesktop.2024.2 version started with process ID 1548.
PyAEDT INFO: Archive C:\Users\ansys\AppData\Local\Temp\tmpi_wzygef.ansys\custom_reports/CISPR25_Radiated_Emissions_Example23R1.aedtz has been restored to project Project_K7P
PyAEDT INFO: Active Design set to 1;CISPR25_Radiated_Emissions_Circuit
PyAEDT INFO: Aedt Objects correctly read
PyAEDT INFO: Key Desktop/ActiveDSOConfigurations/Circuit Design correctly changed.
PyAEDT INFO: Solving all design setups.
PyAEDT INFO: Key Desktop/ActiveDSOConfigurations/Circuit Design correctly changed.
PyAEDT INFO: Design setup None solved correctly in 0.0h 0.0m 25.0s

True

Create a spectral report

The JSON file is used to customize the report. In a spectral report, you can add limit lines. You can also add notes to a report and modify the axes, grid, and legend. Custom reports can be created in AEDT in non-graphical mode using version 2023 R2 and later.

report1 = circuit.post.create_report_from_configuration(
    os.path.join(project_path, "Spectrum_CISPR_Basic.json")
)
out = circuit.post.export_report_to_jpg(
    project_path=circuit.working_directory, plot_name=report1.plot_name
)

PyAEDT INFO: ModelerCircuit class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: ModelerNexxim class has been initialized!
PyAEDT INFO: Modeler class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: Post class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: Report Plot_LH59SJ created successfully.

Render the image.

Image(os.path.join(circuit.working_directory, report1.plot_name + ".jpg"))

You can customize every aspect of the report. The method crate_report_from_configuration() reads the report configuration from a JSON file and generates the custom report.

report1_full = circuit.post.create_report_from_configuration(
    os.path.join(project_path, "Spectrum_CISPR_Custom.json")
)
out = circuit.post.export_report_to_jpg(
    circuit.working_directory, report1_full.plot_name
)
Image(os.path.join(circuit.working_directory, report1_full.plot_name + ".jpg"))

PyAEDT INFO: Report Plot_HCEQ64 created successfully.

Create a transient report

The JSON configuration file can be read and modified from the API prior to creating the report. The following code modifies the trace rendering prior to creating the report.

props = ansys.aedt.core.general_methods.read_json(
    os.path.join(project_path, "Transient_CISPR_Custom.json")
)

report2 = circuit.post.create_report_from_configuration(
    report_settings=props, solution_name="NexximTransient"
)
out = circuit.post.export_report_to_jpg(circuit.working_directory, report2.plot_name)
Image(os.path.join(circuit.working_directory, report2.plot_name + ".jpg"))

PyAEDT INFO: Parsing C:/Users/ansys/AppData/Local/Temp/tmpi_wzygef.ansys/custom_reports/Project_K7P.aedt.
PyAEDT INFO: File C:/Users/ansys/AppData/Local/Temp/tmpi_wzygef.ansys/custom_reports/Project_K7P.aedt correctly loaded. Elapsed time: 0m 1sec
PyAEDT INFO: aedt file load time 0.7588825225830078
PyAEDT INFO: Report Plot_L2B681 created successfully.

The props dictionary can be used to customize any aspect of an existing report or generate a new report. In this example, the name of the curve is customized.

props["expressions"] = {"V(Battery)": {}, "V(U1_VDD)": {}}
props["plot_name"] = "Battery Voltage"
report3 = circuit.post.create_report_from_configuration(
    report_settings=props, solution_name="NexximTransient"
)
out = circuit.post.export_report_to_jpg(circuit.working_directory, report3.plot_name)
Image(os.path.join(circuit.working_directory, report3.plot_name + ".jpg"))

PyAEDT INFO: Report Plot_EUG9G3 created successfully.

Create an eye diagram

You can use the JSON file to create an eye diagram. The following code includes the eye.

report4 = circuit.post.create_report_from_configuration(
    os.path.join(project_path, "EyeDiagram_CISPR_Basic.json")
)
out = circuit.post.export_report_to_jpg(circuit.working_directory, report4.plot_name)
Image(os.path.join(circuit.working_directory, report4.plot_name + ".jpg"))

PyAEDT INFO: Report Plot_27FIYK created successfully.

report4_full = circuit.post.create_report_from_configuration(
    os.path.join(project_path, "EyeDiagram_CISPR_Custom.json")
)

out = circuit.post.export_report_to_jpg(
    circuit.working_directory, report4_full.plot_name
)
Image(os.path.join(circuit.working_directory, report4_full.plot_name + ".jpg"))

PyAEDT INFO: Report Plot_3MA9DJ created successfully.

Save project and close AEDT

Save the project and close AEDT. The example has finished running. You can retrieve project files from temp_folder.name.

circuit.save_project()
print("Project Saved in {}".format(circuit.project_path))

PyAEDT INFO: Project Project_K7P Saved correctly
Project Saved in C:/Users/ansys/AppData/Local/Temp/tmpi_wzygef.ansys/custom_reports/

circuit.release_desktop()
time.sleep(3)

PyAEDT INFO: Desktop has been released and closed.

Clean up

The following cell cleans up the temporary directory and removes all project files.

temp_folder.cleanup()

---

Download this example

Download this example as a Jupyter Notebook or as a Python script.