RAVEN is a flexible and multi-purpose probabilistic risk analysis, validation and uncertainty quantification, parameter optimization, model reduction and data knowledge-discovering framework.
What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)
Closes #2255
What are the significant changes in functionality due to this change request?
When using ravenframework as a Python module, users are able to overwrite sys.stdout with another destination, and this is now honored by RAVEN. This was accomplished by simply removing the writeTo option from MessageHandler.message().
Before settling on removing the option, I also tried to track the argument as an instance variable instead (self._writeTo). However, this approach was rejected for two major reasons. First, storing sys.stdout or a file object from using the open() function as an attribute led to problems pickling the class. While these two cases are simple enough to handle, if the user has supplied their own class for writeTo, it will be impossible to correctly reinstantiate the class upon unpickling. I felt this was then better left to the user to handle outside of RAVEN.
For Change Control Board: Change Request Review
The following review must be completed by an authorized member of the Change Control Board.
[x] 1. Review all computer code.
[x] 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
[x] 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
[x] 4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
[x] 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
[x] 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
[x] 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
[x] 8. If an analytic test is changed/added is the the analytic documentation updated/added?
[x] 9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.
Pull Request Description
What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)
Closes #2255
What are the significant changes in functionality due to this change request?
When using ravenframework as a Python module, users are able to overwrite
sys.stdoutwith another destination, and this is now honored by RAVEN. This was accomplished by simply removing thewriteTooption fromMessageHandler.message().Before settling on removing the option, I also tried to track the argument as an instance variable instead (
self._writeTo). However, this approach was rejected for two major reasons. First, storingsys.stdoutor a file object from using theopen()function as an attribute led to problems pickling the class. While these two cases are simple enough to handle, if the user has supplied their own class forwriteTo, it will be impossible to correctly reinstantiate the class upon unpickling. I felt this was then better left to the user to handle outside of RAVEN.For Change Control Board: Change Request Review
The following review must be completed by an authorized member of the Change Control Board.
<internalParallel>to True.raven/tests/framework/user_guideandraven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.