cep28 #291
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,54 @@ | ||||||
| CEP 26 - Generalize the DRE to Optimize Multiple Metrics | ||||||
| ******************************************************** | ||||||
|
|
||||||
| :CEP: 28 | ||||||
| :Title: Additional Control Input to Manage RecordTimeSeries | ||||||
| :Last-Modified: 3/1/2019 | ||||||
| :Author: Robert Flanagan \& Gwen Chee | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| :Status: Draft | ||||||
| :Type: Standards Track | ||||||
| :Created: 3/1/2019 | ||||||
|
|
||||||
|
|
||||||
| Abstract | ||||||
| ======== | ||||||
| Increased use of the RecordTimeSeries functionality within Cyclus | ||||||
| has caused an increase in the number of tables in a cyclus output | ||||||
| file. While this has yet to impact performance, it is conceivable | ||||||
| that it could become problematic in the future. To combat this | ||||||
| a new cyclus control input field will be added to allow users to | ||||||
| choose which RecordTimeSeries tables to be added to the output. | ||||||
|
There was a problem hiding this comment. I thought we decided on an on and off toggle, rather than specifically choosing which tables? There was a problem hiding this comment. On: all the tables |
||||||
|
|
||||||
|
|
||||||
| Motivation | ||||||
| ========== | ||||||
| The addition of the TimeSeriesListeners added to support the d3ploy | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| archetypes caused an increase in the amount of tables being output | ||||||
| by Cyclus. This change is largely user agnostic however, it can | ||||||
| cause an increased storage space for each run. As this data is unused | ||||||
| by any simulation not using the listeners, it is just wasted hard disk | ||||||
| space. This charge will be used to mitigate this problem. It will also | ||||||
| allow uses to run a simulation that outputs only the specific tables | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| they wish to see in their outputs. | ||||||
|
|
||||||
|
|
||||||
| Specification \& Implementation | ||||||
| =============================== | ||||||
| This charge will add a field to the simulation control that will allow | ||||||
| the user to specify which tables they wish to see. By default this value | ||||||
| will be set to all tables, but if user wishes to specify the tables they | ||||||
| wish to see they will do so by entering the string of each table's name; | ||||||
|
There was a problem hiding this comment. Is this really necessary? Because if a user is using d3ploy to deploy a specific facility, they would probably want to see the table that is associated with that facility and they would probably not have other cycamore facilities in the simulation so those tables won't show up anyway. |
||||||
| Similar to a vector input to a cyclus module. The user will also be | ||||||
| able to turn off all RecordTimeSeries tables. | ||||||
|
|
||||||
|
|
||||||
| Backwards Compatibility | ||||||
| ======================= | ||||||
| By setting the default value of this field to be all tables it should | ||||||
| be fully backwards compatible. | ||||||
|
|
||||||
|
|
||||||
| Document History | ||||||
| ================ | ||||||
|
|
||||||
| This document is released under the CC-BY 4.0 license. | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.