From 06ca3fa0d1ec4e6a7468f98eaf24e01a5bf082cb Mon Sep 17 00:00:00 2001 From: flanflanagan Date: Fri, 1 Mar 2019 08:54:51 -0700 Subject: [PATCH] cep28 --- source/cep/cep28.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 source/cep/cep28.rst diff --git a/source/cep/cep28.rst b/source/cep/cep28.rst new file mode 100644 index 000000000..d859ab940 --- /dev/null +++ b/source/cep/cep28.rst @@ -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 +: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. + + +Motivation +========== +The addition of the TimeSeriesListeners added to support the d3ploy +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 +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; +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.