System.report#

System.report(path=None)[source]#

Write system routine reports to a plain-text file.

Parameters:
pathstr, optional

Output file path or directory. When given, the report is written to the resolved path and the system-level no_output flag is bypassed. When None, the report is written to self.files.txt only if self.files.no_output is False.

Returns:
bool

True if the report was written, False otherwise.

Notes

Differences from ANDES:

  • ANDES has no System.report(); the equivalent is per-routine (e.g. system.PFlow.report()) and takes no path argument.

  • In AMS, an explicit path overrides no_output=True so users can produce a one-off report without flipping the system flag.

Changed in version 1.3.0: Added path parameter.