create_report_from_configuration

PostProcessorIcepak.create_report_from_configuration(input_file=None, report_settings=None, solution_name=None, name=None, matplotlib=False, show=True)

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.

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.

Returns:

ansys.aedt.core.modules.report_templates.Standard

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)