create_report

PostProcessorIcepak.create_report(expressions=None, setup_sweep_name=None, domain: str = 'Sweep', variations: dict | None = None, primary_sweep_variable=None, secondary_sweep_variable=None, report_category=None, plot_type: str = 'Rectangular Plot', context=None, subdesign_id: int | None = None, polyline_points: int = 1001, plot_name=None) → Standard

Create a report in AEDT. It can be a 2D plot, 3D plot, polar plot, or a data table.

Parameters:

expressionsstr or list, optional

One or more formulas to add to the report. Example is value = "dB(S(1,1))".

setup_sweep_namestr, optional

Setup name with the sweep. The default is None, in which case the first setup and sweep is selected. For Circuit Netlist designs only, specify the solution name as listed in ansys.aedt.core.generic.aedt_constants.CircuitNetlistConstants.

domainstr, optional

Plot Domain. Options are “Sweep”, “Time”, “DCIR”.

variationsdict, optional

Dictionary of all families including the primary sweep. The default is {"Freq": ["All"]}.

primary_sweep_variablestr, optional

Name of the primary sweep. The default is "Freq".

secondary_sweep_variablestr, optional

Name of the secondary sweep variable in 3D Plots.

report_categorystr, optional

Category of the Report to be created. If None default data Report is used. The Report Category can be one of the types available for creating a report depend on the simulation setup. For example for a Far Field Plot in HFSS the UI shows the report category as “Create Far Fields Report”. The report category is “Far Fields” in this case. Depending on the setup different categories are available. If None default category is used (the first item in the Results drop down menu in AEDT).

plot_typestr, optional

The format of Data Visualization. Default is Rectangular Plot.

contextstr, dict, optional

The default is None. - For HFSS 3D Layout, options are "Bondwires", "Differential Pairs", None, "Probes", "RL", "Sources", and "Vias". - For Q2D or Q3D, specify the name of a reduced matrix. - For a far fields plot, specify the name of an infinite sphere. - For Maxwell 2D/3D Eddy Current solution types this can be provided as a dictionary where the key is the matrix name and value the reduced matrix. - For Circuit Design, this can provide the plots’ time range as a dictionary where the keys are "time_start" and "time_stop". By default "time_start" is 0ps and the "time_stop" is 10ns. - For TDR analysis some dictionary options are “pulse_rise_time”,”step_time”, “time_windowing”,”maximum_time”,”use_pulse_in_tdr”,”differential_pairs”. The default values are as they appear manually in the UI.

plot_namestr, optional

Name of the plot. The default is None.

polyline_pointsint, optional,

Number of points to create the report for plots on polylines on.

subdesign_idint, optional

Specify a subdesign ID to export a Touchstone file of this subdesign. Valid for Circuit Only. The default value is None.

Returns:

ansys.aedt.core.visualization.report.standard.Standard

True when successful, False when failed.

References

>>> oModule.CreateReport

Examples

HFSS Example >>> from ansys.aedt.core import Hfss >>> hfss = Hfss() >>> hfss.post.create_report(“dB(S(1,1))”) >>> variations = hfss.available_variations.nominal_values >>> variations[“Theta”] = [“All”] >>> variations[“Phi”] = [“All”] >>> variations[“Freq”] = [“30GHz”] >>> hfss.post.create_report( … expressions=”db(GainTotal)”, … setup_sweep_name=hfss.nominal_adaptive, … variations=variations, … primary_sweep_variable=”Phi”, … secondary_sweep_variable=”Theta”, … report_category=”Far Fields”, … plot_type=”3D Polar Plot”, … context=”3D”, … ) >>> hfss.post.create_report(“S(1,1)”, hfss.nominal_sweep, variations=variations, plot_type=”Smith Chart”) >>> hfss.desktop_class.release_desktop(False, False)

Maxwell 2D Example - Field report on a polyline >>> from ansys.aedt.core import Maxwell2d >>> m2d = Maxwell2d(version=”2025.2”) Setup model >>> circ = m2d.modeler.create_circle(origin=[0, 0, 0], radius=5, material=”copper”) >>> poly = m2d.modeler.create_polyline(points=[[8, 8, 0], [8, -10, 0]], name=”Poly1”) >>> m2d.assign_current(assignment=circ.name, amplitude=5) >>> region = m2d.modeler.create_region(pad_value=100) >>> m2d.assign_balloon(assignment=region.edges) >>> setup = m2d.create_setup() >>> m2d.analyze_setup(setup.name) Create a field report on the polyline >>> report = m2d.post.create_report( … expressions=”Mag_B”, … setup_sweep_name=m2d.nominal_adaptive, … plot_type=”Rectangular Plot”, … report_category=”Fields”, … context=poly.name, … primary_sweep_variable=”Distance”, … ) >>> m2d.release_desktop(False, False)

Circuit Netlist Example >>> from ansys.aedt.core import CircuitNetlist >>> from ansys.aedt.core.generic.aedt_constants import CircuitNetlistConstants >>> cir = CircuitNetlist(version=”2025.2”) To get the available report solution there are two options: >>> solutions = cir.post.available_report_solutions()[0] or >>> solutions = CircuitNetlistConstants.solution_types[“NexximLNA”][“name”] Get the available report categories >>> categories = cir.post.available_report_types(solution=solutions)[0] Get the available report quantities for a specific category and solution >>> quantities = cir.post.available_report_quantities(quantities_category=”Noise”, solution=solution) Create the report for each quantity >>> for quantity in quantities: … cir.post.create_report( … expressions=f”dB({quantity})”, … setup_sweep_name=”NexximLNA”, … plot_type=”Rectangular Plot”, … report_category=”Noise”, … domain=”Sweep”, … primary_sweep_variable=”Freq”, … ) >>> cir.desktop_class.release_desktop(False, False)