create_report_from_configuration#

PostProcessor3D.create_report_from_configuration(input_file=None, report_settings=None, solution_name=None, name=None, matplotlib=False)#

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 if use AEDT or ReportPlotter to generate the plot. Eye diagrams are not supported.

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.general_methods import read_json >>> hfss = Hfss() >>> dict_vals = read_json(“Report_Simple.json”) >>> hfss.post.create_report_from_configuration(report_settings=dict_vals)