Report commands#

NaxToView functions to create reports from the active view.

n2vscripting.report.create_report(path: str, items: list[int], item_type: str, lcs_incr: list[tuple[int, int]], result: str, components: list[str], sections: str, all_incr: bool = False, sort_by: str = 'LC', avg_sec: str = 'Maximum', avg_pos: str = 'Maximum', variation: int = 100, coord_sys_id: int = -1, complex_format: str = 'Real', corner_data: bool = False, env_only: bool = False)#

Create a Report on the active view and save it to a file.

More detailed description of the function and how to use it and bla bla bla.

Parameters:
  • path (str) – Path of the file the report is to be saved to.

  • items (list[int]) – List of element or node ids.

  • item_type (str) – ‘Elements’ or ‘Nodes’

  • lcs_incr (list[tuple[int, int]]) – list of tuples of load case ids and increments to include in the report.

  • result (str) – name of the result

  • components (list[str]) – list of names of components to include in the report.

  • all_incr (bool, optional) – Whether to include all increments or just the ones specified in lcs_incr. Default is False.

  • sections (str) – A string with the sections to include in the report. The sections are separated by #. Whether to include all increments or just the ones specified in lcs_incr.

  • sort_by (str, optional) – ‘LC’ or ‘Item’. If ‘LC’, the report will be sorted by load case. If ‘Item’, the report will be sorted by item.

  • avg_sec (str, optional) – A string that specifies the criterion to be used for section averaging.

  • avg_pos (str, optional) – A string that specifies the criterion to be used for position averaging.

  • variation (int, optional) – An integer that specifies the variation to be used for the report. Default is 100.

  • coord_sys_id (int, optional) – An integer that specifies the coordinate system to be used for the report. Default is -1.

  • complex_format (str, optional) – A string that specifies the complex format to be used for the report. Options are: ‘Real’, ‘Cartesian’ and ‘Polar’. Default is ‘Real’.

  • corner_data (bool, optional) – A boolean that specifies whether to express the results at nodal positions. Default is False.

  • env_only (bool, optional) – A boolean that specifies whether to include only the envelope results. Default is False.

Examples

>>> n2v.create_report("C:/Path/To/Report.csv", [100000, 100001, 100002], "Elements", [(1, 0), (2, 0)], "STRESSES", ["XX", "YY", "ZZ"], "Z1#Z2#")