Merge pull request #415 from j-bryan/misc_fixes

Print statements, npv_exempt cash flows, dispatch plot fixes

Author: dylanjm

src/Cases.py

@@ -281,10 +281,12 @@ def _specs_debug(cls):
     debug.addSub(InputData.parameterInputFactory('macro_steps', contentType=InputTypes.IntegerType,
         descr=r"""sets the number of macro steps (e.g. years) the stochastic synthetic histories and dispatch
               optimization should include. \default{1}"""))
-    debug.addSub(InputData.parameterInputFactory('dispatch_plot', contentType=InputTypes.BoolType,
+    dispatch_plot = InputData.parameterInputFactory('dispatch_plot', contentType=InputTypes.BoolType,
         descr=r"""provides a dispatch plot after running through \xmlNode{inner_samples} and
               \xmlNode{macro_steps} provided. To prevent plotting output during debug mode set to "False".
-              \default{True}"""))
+              \default{True}""")
+    dispatch_plot.addParam('sep_by_resource', param_type=InputTypes.BoolType, descr=r"""produce one figure per resource. \default{False}""")
+    debug.addSub(dispatch_plot)
     debug.addSub(InputData.parameterInputFactory('cashflow_plot', contentType=InputTypes.BoolType,
         descr=r"""provides a cashflow plot after running through \xmlNode{inner_samples} and
               \xmlNode{macro_steps} provided. To prevent plotting output during debug mode set to "False".
@@ -656,6 +658,7 @@ def __init__(self, run_dir, **kwargs):
         'inner_samples': 1,            # how many inner realizations to sample
         'macro_steps': 1,              # how many "years" for inner realizations
         'dispatch_plot': True,         # whether to output a dispatch plot in debug mode
+        'disp_plot_sep': False,        # whether to separate dispatch plots into one figure per resource
         'cashflow_plot': True          # whether to output a cashflow plot in debug mode
     }
 
@@ -694,6 +697,8 @@ def read_input(self, xml):
         self.debug['enabled'] = True
         for node in item.subparts:
           self.debug[node.getName()] = node.value
+          if node.getName() == 'dispatch_plot':
+            self.debug['disp_plot_sep'] = node.parameterValues.get('sep_by_resource', False)
       elif item.getName() == 'label':
         self._labels[item.parameterValues['name']] = item.value
       if item.getName() == 'verbosity':

src/DispatchManager.py

@@ -571,10 +571,8 @@ def _segment_cashflow(self, meta, s, seg, year, dispatch, multiplicity,
       specific_meta['HERON']['all_activity'] = dispatch
       specific_activity = {}
       final_cashflows = final_comp.getCashflows()
-      for f, heron_cf in enumerate(comp.get_cashflows()):
+      for f, heron_cf in enumerate(filter(lambda cf: not cf.is_npv_exempt(), comp.get_cashflows())):
         # get the corresponding TEAL.CashFlow
-        if heron_cf.is_npv_exempt():
-          continue # Skip adding this cashflow to the final cashflows
         teal_cf = teal_comp.getCashflows()[f]
         final_cf = final_cashflows[f]
         # sanity continued

src/DispatchPlot.py

@@ -49,6 +49,7 @@ def getInputSpecification(cls):
     specs.addSub(InputData.parameterInputFactory('macro_variable', contentType=InputTypes.StringType))
     specs.addSub(InputData.parameterInputFactory('micro_variable', contentType=InputTypes.StringType))
     specs.addSub(InputData.parameterInputFactory('signals', contentType=InputTypes.StringListType))
+    specs.addSub(InputData.parameterInputFactory('sep_by_resource', contentType=InputTypes.BoolType))
     return specs
 
   def __init__(self):
@@ -63,6 +64,7 @@ def __init__(self):
     self._source = None
     self._macroName = None
     self._microName = None
+    self._sepByResource = False
     self._addSignals = []
 
   def handleInput(self, spec):
@@ -81,6 +83,8 @@ def handleInput(self, spec):
         self._microName = node.value
       elif node.getName() == 'signals':
         self._addSignals = node.value
+      elif node.getName() == 'sep_by_resource':
+        self._sepByResource = node.value
 
   def initialize(self, stepEntities):
     """
@@ -329,10 +333,19 @@ def run(self):
       # nature of the subplots, as well as the dynamic number of
       # components and signals to plot (i.e. dynamically nested subplots)
 
-      # If only 3 resources, make one figure; otherwise, 2 resources per figure
-      if len(resources) <= 3:
+      # Use a separate figure for each resource, if requested.
+      if self._sepByResource:
+        res_figs = []
+        res_axs = []
+        for _ in range(len(resources)):
+          fig, axs = plt.subplots()
+          res_figs.append(fig)
+          res_axs.append(axs)
+      # Otherwise, if only 3 resources, make one figure
+      elif len(resources) <= 3:
         fig, res_axs = plt.subplots(len(resources), 1, sharex=True, squeeze=False)
         res_figs = [fig]
+      # Otherwise if more than 3 resources, plot 2 resources per figure
       else:
         res_figs = []
         res_axs = []

templates/bilevel_templates.py

@@ -99,25 +99,22 @@ def createWorkflow(self, **kwargs) -> dict[str, ET.Element]:
 
     return {"inner": self.inner.template_xml, "outer": self.outer.template_xml}
 
-  def writeWorkflow(self, template: dict[str, ET.Element], destination: dict[str, str], run: bool = False) -> None:
+  def writeWorkflow(self, dest_dir: str) -> None:
     """
       Writes a template to file.
-      @ In, template, dict[str, ET.Element], XML trees to write
-      @ In, destination, dict[str, str], paths to write the templates to
-      @ In, run, bool, optional, if True then run the workflow after writing? good idea?
-      @ Out, errors, int, 0 if successfully wrote [and run] and nonzero if there was a problem
+      @ In, dest_dir, str, path to the directory to which to write template workflows
+      @ Out, None
     """
-    for name, xml in template.items():
-      super().writeWorkflow(xml, destination[name], run)
+    self.inner.writeWorkflow(dest_dir)
+    self.outer.writeWorkflow(dest_dir)
 
     # copy "write_inner.py", which has the denoising and capacity fixing algorithms
     conv_filename = "write_inner.py"
     write_inner_dir = Path(__file__).parent
-    dest_dir = Path(next(iter(destination.values()))).parent
     conv_src = write_inner_dir / conv_filename
-    conv_file = dest_dir / conv_filename
+    conv_file = Path(dest_dir) / conv_filename
     shutil.copyfile(str(conv_src), str(conv_file))
-    print(f"Wrote '{conv_filename}' to '{destination}'")
+    print(f"Wrote '{conv_filename}' to '{str(conv_file)}'")
 
   @property
   def template_xml(self) -> dict[str, ET.Element]:

templates/debug_template.py

@@ -268,6 +268,7 @@ def _make_dispatch_plot(self, case: HeronCase) -> HeronDispatchPlot:
     disp_plot.macro_variable = case.get_year_name()
     disp_plot.micro_variable = case.get_time_name()
     disp_plot.signals.append("GRO_debug_synthetics")
+    disp_plot.sep_by_resource = case.debug["disp_plot_sep"]
     return disp_plot
 
   def _make_cashflow_plot(self) -> TealCashFlowPlot:

templates/raven_template.py

@@ -13,7 +13,7 @@
 import itertools as it
 import xml.etree.ElementTree as ET
 
-from .imports import xmlUtils, Template
+from .imports import Template
 from .heron_types import HeronCase, Component, Source, ValuedParam
 from .naming_utils import get_result_stats, get_component_activity_vars, get_opt_objective, get_statistics, Statistic
 from .xml_utils import add_node_to_tree, stringify_node_values
@@ -26,7 +26,7 @@
 from .snippets.models import GaussianProcessRegressor, PickledROM, EnsembleModel
 from .snippets.distributions import Distribution, Uniform
 from .snippets.outstreams import PrintOutStream
-from .snippets.dataobjects import DataObject, PointSet, DataSet
+from .snippets.dataobjects import PointSet, DataSet
 from .snippets.variablegroups import VariableGroup
 from .snippets.files import File
 from .snippets.factory import factory as snippet_factory
@@ -118,27 +118,26 @@ def createWorkflow(self, **kwargs) -> None:
     # Universal workflow settings
     self._set_verbosity(kwargs["case"].get_verbosity())
 
-  def writeWorkflow(self, template: ET.Element, destination: str, run: bool = False) -> None:
+  def writeWorkflow(self, dest_dir: str) -> None:
     """
       Writes a template to file.
-      @ In, template, xml.etree.ElementTree.Element, file to write
-      @ In, destination, str, path and filename to write to
-      @ In, run, bool, optional, if True then run the workflow after writing? good idea?
-      @ Out, errors, int, 0 if successfully wrote [and run] and nonzero if there was a problem
+      @ In, dest_dir, str, path to the directory to which to write template workflows
+      @ Out, None
     """
     # Ensure all node attribute values and text are expressed as strings. Errors are thrown if any of these aren't
     # strings. Enforcing this here allows flexibility with how node values are stored and manipulated before write
     # time, such as storing values as lists or numeric types. For example, text fields which are a comma-separated
     # list of values can be stored in the RavenSnippet object as a list, and new items can be inserted into that
     # list as needed, then the list can be converted to a string only now at write time.
-    stringify_node_values(template)
+    stringify_node_values(self._template)
 
     # Remove any unused top-level nodes (Models, Samplers, etc.) to keep things looking clean
-    for node in template:
+    for node in self._template:
       if len(node) == 0:
-        template.remove(node)
+        self._template.remove(node)
 
-    super().writeWorkflow(template, destination, run)
+    destination = self.get_write_path(dest_dir)
+    super().writeWorkflow(self._template, destination)
     print(f"Wrote '{self.write_name}' to '{destination}'")
 
   @property
@@ -221,7 +220,7 @@ def _set_case_name(self, name: str) -> None:
     @ In, name, str, case name to use
     @ Out, None
     """
-    run_info = self._template.find("RunInfo")  # type: RunInfo
+    run_info: RunInfo = self._template.find("RunInfo")
     run_info.job_name = name
     run_info.working_dir = name
 
@@ -232,7 +231,7 @@ def _add_step_to_sequence(self, step: Step, index: int | None = None) -> None:
     @ In, index, int, optional, the index to add the step at
     @ Out, None
     """
-    run_info = self._template.find("RunInfo")  # type: RunInfo
+    run_info: RunInfo = self._template.find("RunInfo")
     idx = index if index is not None else len(run_info.sequence)
     run_info.sequence.insert(idx, step)
 
@@ -264,7 +263,7 @@ def _load_file_to_object(self, source: Source, target: RavenSnippet) -> IOStep:
     @ Out, step, IOStep, the step used to do the loading
     """
     # Get the file to load. Might already exist in the template XML
-    file = self._template.find("Files/Input[@name='{source.name}']")  # type: File
+    file: File | None = self._template.find("Files/Input[@name='{source.name}']")
     if file is None:
       file = File(source.name)
       file.path = source._target_file
@@ -416,14 +415,14 @@ def _add_time_series_roms(self, ensemble_model: EnsembleModel, case: HeronCase,
     @ In, sources, list[Source], case sources
     @ Out, None
     """
-    dispatch_eval = self._template.find("DataObjects/DataSet[@name='dispatch_eval']")  # type: DataSet
+    dispatch_eval: DataSet = self._template.find("DataObjects/DataSet[@name='dispatch_eval']")
 
     # Gather any ARMA sources from the list of sources
     arma_sources = [s for s in sources if s.is_type("ARMA")]
 
     # Add cluster index info to dispatch variable groups and data objects
     if any(source.eval_mode == "clustered" for source in arma_sources):
-      vg_dispatch = self._template.find("VariableGroups/Group[@name='GRO_dispatch']")  # type: VariableGroup
+      vg_dispatch: VariableGroup = self._template.find("VariableGroups/Group[@name='GRO_dispatch']")
       vg_dispatch.variables.append(self.namingTemplates["cluster_index"])
       dispatch_eval.add_index(self.namingTemplates["cluster_index"], "GRO_dispatch_in_Time")
 
@@ -555,7 +554,7 @@ def _get_uncertain_cashflow_params(self,
           dist_name = self.namingTemplates["distribution"].format(variable=feat_name)
 
           # Reconstruct distribution XML node from valuedParam definition
-          dist_node = vp._vp.get_distribution()  # type: ET.Element
+          dist_node: ET.Element = vp._vp.get_distribution()
           dist_node.set("name", dist_name)
           dist_snippet = snippet_factory.from_xml(dist_node)
           distributions.append(dist_snippet)
@@ -597,7 +596,7 @@ def _create_sampler_variables(self,
       interaction = component.get_interaction()
       name = component.name
       var_name = self.namingTemplates["variable"].format(unit=name, feature="capacity")
-      cap = interaction.get_capacity(None, raw=True)  # type: ValuedParam
+      cap: ValuedParam = interaction.get_capacity(None, raw=True)
 
       if not cap.is_parametric():  # we already know the value
         continue
@@ -640,7 +639,7 @@ def _configure_static_history_sampler(self,
     if case.debug["enabled"]:
       indices.append(cluster_index)
 
-    time_series_vargroup = self._template.find("VariableGroups/Group[@name='GRO_timeseries']")  # type: VariableGroup
+    time_series_vargroup: VariableGroup = self._template.find("VariableGroups/Group[@name='GRO_timeseries']")
 
     for source in filter(lambda x: x.is_type("CSV"), sources):
       # Add the source variables to the GRO_timeseries_in variable group

templates/snippets/outstreams.py

@@ -155,6 +155,35 @@ def signals(self, value: list[str]) -> None:
     """
     find_node(self, "signals").text = value
 
+  @property
+  def sep_by_resource(self) -> bool:
+    """
+    Getter for sep_by_resource node
+    @ In, None
+    @ Out, sep, bool, separate plots for each resource
+    """
+    # "True" conditions
+    #   - node present and text is None
+    #   - node present and text is True
+    # "False" conditions
+    #   - node not present
+    #   - node present and text is False
+    node = self.find("sep_by_resource")
+    # Need to be careful with falsy condition since bool(None) == False
+    if node is None or (not bool(node.text) and node.text is not None):
+      sep = False
+    else:
+      sep = True
+    return sep
+
+  @sep_by_resource.setter
+  def sep_by_resource(self, value: bool):
+    """
+    Setting for sep_by_resource node
+    @ In, value, bool, separate plots for each resource
+    @ Out, None
+    """
+    find_node(self, "sep_by_resource").text = value
 
 class TealCashFlowPlot(OutStream):
   """ OutStream snippet for TEAL cashflow plots """

templates/template_driver.py

@@ -88,15 +88,14 @@ def write_workflow(self, dest_dir: str, case: HeronCase, components: list[Compon
     print("========================")
     print("HERON: writing files ...")
     print("========================")
-    dest = self.template.get_write_path(dest_dir)
-    self.template.writeWorkflow(self.template.template_xml, dest)
+    self.template.writeWorkflow(dest_dir)
 
     # Write library of info so it can be read in dispatch during inner run. Doing this here ensures that the lib file
     # is written just once, no matter the number of workflow files written by the template.
     lib_file = Path(dest_dir) / self.template.namingTemplates["lib file"]
     with lib_file.open("wb") as lib:
       pk.dump((case, components, sources), lib)
-    print(f"Wrote '{lib_file.name}' to '{str(lib_file.resolve())}'")
+    print(f"Wrote '{lib_file.name}' to '{str(lib_file)}'")
 
   ###################
   # Utility methods #

tests/integration_tests/mechanics/debug_mode/sweep/heron_input.xml

@@ -15,7 +15,7 @@
     <debug>
       <inner_samples>2</inner_samples>
       <macro_steps>2</macro_steps>
-      <dispatch_plot>True</dispatch_plot>
+      <dispatch_plot sep_by_resource="True">True</dispatch_plot>
     </debug>
     <num_arma_samples>1</num_arma_samples>
     <time_discretization>

tests/integration_tests/mechanics/npv_exempt/heron_input.xml

@@ -4,15 +4,15 @@
     <author>dylanjm</author>
     <created>2024-03-26</created>
     <description>
-      Tests NPV exempt Cashflows. This is a recreation of the Cashflows test from 
+      Tests NPV exempt Cashflows. This is a recreation of the Cashflows test from
       the HERON test suite. The only difference is the Variable Operating and Maitenance
-      Costs (VOM) cashflow is now NPV exempt. The Excel File 'analytic.xlsx' shows 
-      the expected results. When the NPV exemption is turned on, the mean NPV for 
+      Costs (VOM) cashflow is now NPV exempt. The Excel File 'analytic.xlsx' shows
+      the expected results. When the NPV exemption is turned on, the mean NPV for
       both sweep values (1, 2) should be: $5,373.37 and $10,748.27 respectively.
-      When NPV exemption is turned off (i.e. the Cashflows test) the results for 
+      When NPV exemption is turned off (i.e. the Cashflows test) the results for
       both sweep values should be $5,218.73 and $10,439.00 respectively. We can see
       that having the VOM cashflow NPV exempt increases the mean NPV in both cases
-      since VOM is a cost and is left out of the NPV calculation.                                        
+      since VOM is a cost and is left out of the NPV calculation.
     </description>
     <classesTested>HERON</classesTested>
   </TestInfo>
@@ -62,6 +62,14 @@
             </scaling_factor_x>
           <!--  <depreciate>5</depreciate> -->
           </CashFlow>
+          <CashFlow name="VOM" type="repeating" taxable="True" inflation="none" npv_exempt="True">
+            <driver>
+              <activity>a</activity>
+            </driver>
+            <reference_price>
+              <fixed_value>-1</fixed_value>
+            </reference_price>
+          </CashFlow>
           <CashFlow name="FOM" type="repeating" period='year' taxable="False" inflation="none">
             <driver>
               <variable>source_capacity</variable>
@@ -77,14 +85,6 @@
               <fixed_value>0.999</fixed_value>
             </scaling_factor_x>
           </CashFlow>
-          <CashFlow name="VOM" type="repeating" taxable="True" inflation="none" npv_exempt="True">
-            <driver>
-              <activity>a</activity>
-            </driver>
-            <reference_price>
-              <fixed_value>-1</fixed_value>
-            </reference_price>
-          </CashFlow>
         </economics>
       </Component>