Report management#

AEDT provides extensive flexibility for generating reports.

PyAEDT includes dedicated classes to manipulate all report properties, offering full control over report customization.

Note

Some functionalities are available only when AEDT is running in graphical mode.

`standard.Standard`	Provides a reporting class that fits most of the app's standard reports.
`standard.Spectral`	Provides for managing spectral reports from transient data.
`field.AntennaParameters`	Provides a reporting class that fits antenna parameter reports in an HFSS plot.
`field.Fields`	Provides for managing fields.
`field.NearField`	Provides for managing near field reports.
`field.FarField`	Provides for managing far field reports.
`field.Emission`	Provides for managing emission reports.
`eye.EyeDiagram`	Provides for managing eye diagram reports.
`eye.AMIConturEyeDiagram`	Provides for managing eye contour diagram reports in AMI analysis.
`eye.AMIEyeDiagram`	Provides for managing eye diagram reports.
`emi.EMIReceiver`	Provides for managing EMI receiver reports.

The following code shows how to use report modules in standalone mode.

# Create `Mag_E` report in a polyline

from ansys.aedt.core import Hfss
from ansys.aedt.core.visualization.report.field import Fields

app = Hfss(specified_version="2024.2",
           non_graphical=False,
           new_desktop_session=False
           )
test_points = [["0mm", "0mm", "0mm"], ["100mm", "20mm", "0mm"],
               ["71mm", "71mm", "0mm"], ["0mm", "100mm", "0mm"]]
p1 = app.modeler.create_polyline(test_points)
setup = app.create_setup()

report = Fields(app=app, report_category="Fields",
                setup_name=setup.name + " : LastAdaptive",
                expressions="Mag_E")
report.polyline = p1.name
report.create()

app.release_desktop(False, False)

You can use these classes directly from the application object:

# Create `Mag_E` report in a polyline

from ansys.aedt.core import Hfss

app = Hfss(specified_version="2024.2",
           non_graphical=False,
           new_desktop_session=False
           )
test_points = [["0mm", "0mm", "0mm"], ["100mm", "20mm", "0mm"],
               ["71mm", "71mm", "0mm"], ["0mm", "100mm", "0mm"]]
p1 = app.modeler.create_polyline(test_points)
setup = app.create_setup()

report = app.post.reports_by_category.fields("Mag_E", setup.name + " : LastAdaptive", p1.name)
report.create()

app.release_desktop(False, False)