API reference

This is the API reference documentation for the pyansys-tools-report package

PyAnsys Tools Report package.

class ansys.tools.report.Report(additional=None, ncol=3, text_width=80, sort=False, gpu=True, ansys_vars=None, ansys_libs=None)

Generate a scooby.Report instance.

Parameters:

additionallist(ModuleType), list(str), default: None

List of packages or package names to add to output information.

ncolint, default: 3

Number of package-columns in the HTML table. This parameter is applicable only has effect if mode='HTML' or mode='html'.

text_widthint, default: 80

Text width for non-HTML display modes.

sortbool, default: False

Whether to alphabetically sort the packages.

gpubool, default: True

Whether to gather information about the GPU. While the default is``True``, if rendering issues are experienced, pass False to safely generate a report.

ansys_varslist of str, default: None

List containing the Ansys environment variables to report on. For example, ["MYVAR_1", "MYVAR_2" ...]

ansys_libsdict {strstr}, default: None

Dictionary containing the Ansys libraries and versions to report on. For example, {"MyLib" : "v1.2", ...}.

project_info()

Get information regarding the Ansys environment and installation.

Returns:

str

Project information (environment variables and installation).

ansys.tools.report.version()

Return the version of the PyAnsys Report Tool.

Returns:

str

The version of the tool being used.