create_report_from_configuration

PostProcessor3D.create_report_from_configuration(input_file: str = None, report_settings: dict = None, solution_name: str = None, name: str = None, matplotlib: bool = False, show: bool = True, hide_legend: bool = False, snapshot_path: str = None, width: int = 800, height: int = 450) → Standard | AMIEyeDiagram | AMIConturEyeDiagram | EMIReceiver | EyeDiagram | CircuitNetlistReport | Fields | FarField | NearField | Spectral | ReportPlotter | None | bool

Create a report based on a JSON file, TOML file, RPT file, or dictionary of properties.

Parameters:

input_filestr, optional

Path to the JSON, TOML, or RPT file containing report settings.

report_settingsdict, optional

Dictionary containing report settings.

solution_namestr, optional

Setup name to use.

namestr, optional

Report name. The default is None, in which case the default name is used.

matplotlibbool, optional

Whether to use AEDT or ReportPlotter to generate the plot. Eye diagrams are not supported.

showbool, optional

Whether to show the plot when using ReportPlotter. The default is True. If matplotlib is False, this parameter is ignored.

hide_legendbool, optional

Whether to hide the legend when using AEDT reporter. The default is False.

snapshot_pathstr, optional

Full path to image file if a snapshot is needed. The default is None.

widthint, optional

Image width. Default is 800 which takes Desktop size or 800 pixel.

heightint, optional

Image height. Default is 450 which takes Desktop size or 450 pixel.

Returns:

ansys.aedt.core.modules.report_templates.Standard or None

Report object if succeeded.

Examples

Create report from JSON file. >>> from ansys.aedt.core import Hfss >>> hfss = Hfss() >>> hfss.post.create_report_from_configuration( … r”C:tempmy_report.json”, solution_name=”Setup1 : LastAdpative” … )

Create report from RPT file. >>> from ansys.aedt.core import Hfss >>> hfss = Hfss() >>> hfss.post.create_report_from_configuration(r”C:tempmy_report.rpt”)

Create report from dictionary. >>> from ansys.aedt.core import Hfss >>> from ansys.aedt.core.generic.file_utils import read_json >>> hfss = Hfss() >>> dict_vals = read_json(“Report_Simple.json”) >>> hfss.post.create_report_from_configuration(report_settings=dict_vals)