create_report#
- Setup.create_report(expressions=None, domain='Sweep', variations=None, primary_sweep_variable=None, secondary_sweep_variable=None, report_category=None, plot_type='Rectangular Plot', context=None, subdesign_id=None, polyline_points=1001, name=None, sweep=None)[source]#
Create a report in AEDT. It can be a 2D plot, 3D plot, polar plot, or data table.
- Parameters:
- expressions
str
orlist
,optional
One or more formulas to add to the report. Example is value =
"dB(S(1,1))"
.- domain
str
,optional
Plot Domain. Options are “Sweep”, “Time”, “DCIR”.
- variations
dict
,optional
Dictionary of all families including the primary sweep. The default is
{"Freq": ["All"]}
.- primary_sweep_variable
str
,optional
Name of the primary sweep. The default is
"Freq"
.- secondary_sweep_variable
str
,optional
Name of the secondary sweep variable in 3D Plots.
- report_category
str
,optional
Category of the Report to be created. If None default data Report will be 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 will be in this case “Far Fields”. Depending on the setup different categories are available. If None default category will be used (the first item in the Results drop down menu in AEDT).
- plot_type
str
,optional
The format of Data Visualization. Default is
Rectangular Plot
.- context
str
,optional
The default is
None
. It can be None, “Differential Pairs”,`”RL”, `”Sources”, “Vias”,`”Bondwires”, `”Probes” for Hfss3dLayout or Reduce Matrix Name for Q2d/Q3d solution or Infinite Sphere name for Far Fields Plot.- name
str
,optional
Name of the plot. The default is
None
.- polyline_points
int
, optional, Number of points for creating the report for plots on polylines.
- subdesign_id
int
,optional
Specify a subdesign ID to export a Touchstone file of this subdesign to. This parameter is valid only for a circuit. The default value is
None
.- sweep
str
,optional
Name of the sweep adaptive setup to get solutions from. The default is
LastAdaptive
.
- expressions
- Returns:
ansys.aedt.core.modules.report_templates.Standard
True
when successful,False
when failed.
References
>>> oModule.CreateReport
Examples
>>> from ansys.aedt.core import Circuit >>> aedtapp = Circuit() >>> aedtapp.post.create_report("dB(S(1,1))")
>>> variations = aedtapp.available_variations.nominal_w_values_dict >>> aedtapp.post.setups[0].create_report("dB(S(1,1))",variations=variations,primary_sweep_variable="Freq")
>>> aedtapp.post.create_report("S(1,1)",variations=variations,plot_type="Smith Chart")