-
Notifications
You must be signed in to change notification settings - Fork 97
Description
When an ARMI-based reactor simulation finishes it produces a table describing all the warnings that were found during the run:
Lines 621 to 624 in 0e830d2
| def warningReport(self): | |
| """Summarize all warnings for the run.""" | |
| self.info("----- Final Warning Count --------") | |
| self.info(" {0:^10s} {1:^25s}".format("COUNT", "LABEL")) |
It is a common need in nuclear reactor modeling to disposition and review all warnings that were encountered in an analysis of record. The above report does help the user understand what warnings were encountered, but it does not provide immediate access to questions like:
- How do I fix this warning?
- What use-case(s) would care about this warning?
We need to improve this system, to help the user base. Currently ARMI includes 159 possible warnings that might be encountered during a run. It would be nice if those were documented in some way (preferably automatically).
This will be a big task, at a guess I think it should be broken down into separable stages:
- Make
runLog.error()raise an error. - Review all ARMI
runLogstatements to remove those that are not useful. - Review all ARMI
runLogstatements to reduce the log level of those statements which should be reduces (say frominfotoextra, etc). - Review and improve the clarity of all warning statements.
- Document all warning statements.