specl(): Proposed function definition for SPEC-ACTIONS

[rburghol]

propose at https://github.com/respec/HSPsquared/issues/90

• def specl(io_manager, siminfo, ui, ts, state, specl_actions):
  • io_manager: global facility to pull data. Minimize calls to io_manager within loops if possible for speed
  • siminfo: global info like start, end, timestep other?
  • ui: uci data for current block, ie rchres/hydr (verify this path in the Data Dictionary)
  • ts: timeseries/[block], ie timeseries/rchres
  • state: ts[step -1]; the state array for the domain (i.e. RCHRES variables), this is crucial as state variables in the code are simply named variables, not a member of an array, thus difficult to pass into a routine such as specl(), however, all values that are relevant should be set at the end of each timestep in the ts dictionary, so, passing the last state is both a reasonable way of insuring that only the values that should be public are passed, and that the expected state of the system at the last time step is what special actions are acting upon.
  • Question: does setting a value in the state dictionary propagate back to the variable in the calling loop that contains that state?
  • specl_actions: local reach SAs (could be global list of SAs), and objects
  • this can be acquired from io_manager in the calling routine prior to looping, so that we avoid redundant data retrievals.
  • propose get_specl() in the manner of get_timeseries() see def get_timeseries
• Old version hspf used SUBROUTINE SPECL,
• convention in new model is to code wrapper function python equivalents as [old hspf fn], which receives data at each time step then calls python equivalent to old function _[old hspf function name in lower case]_
  • Ex: define hydr() calls _hydr_() see HYDR.py

[jdkleiner]

work session 9/7/22

• def _hydr_(ui, ts, COLIND, OUTDGT, rowsFT, funct, Olabels, OVOLlabels, specactions):
• def specl(uci, ts, step, specactions):
• def _specl_(uci, ts, step, specactions):

[jdkleiner]

HSP2 flowchart (incomplete)

Questions:

• I'm having trouble loading any modules on deq1 (deq3)
  • pandas, h5py etc.
  • spent time adjusting where python looks for the python/module installation
  • hsp2 was having no trouble loading them the last time I ran the model. Check the installation issue: #9
• Where do the different model objects come in to the sequence? https://github.com/HARPgroup/HSPsquared/issues/7
  • We don't know yet. Objects may be an enhancement to the specl facility from the original model, but it may be more appropriate to make them a separate module but we are using this issue to scope that out.
• When does the demand() function come into play? (located in HYDR.py)
  • demand() appears to get arguments pertaining to OUTDGT, hence, I think that anything that alters OUTDGT will influence the processing of demand(), but a primary purpose of this scoping is to determine precisely how that works.
• Is OUTDGT different from the withdrawal parameter that will be in the specactions dictionary?
  • OUTDGT will be set by specl entities.
• Where will the parser come into the sequence?
  • The parser is at the very beginning when we run hsp2 import_uci. Check the parser issue for detail. https://github.com/respec/HSPsquared/issues/99
  • it may be a good idea to merge the parser branch into your development branch. It doesn't work, but it dorsn't break anything and it does tie the different functions together.
• Is the HARP hydr CSV the input to specactions = {}? https://github.com/HARPgroup/HARParchive/issues/536#issuecomment-1245729144
  • specactions is populated when the UCI is read. See https://github.com/respec/HSPsquared/issues/99
• Would be good to have an easy way to visualize model results of test runs (using one of the HARP scripts): https://github.com/HARPgroup/HARParchive/issues/505
  • I project they will have the whole set of hydrology metrics integrated next week. :)

[rburghol]

Answered some of your questions in line. Let's tackle these in tomorrow's work sesh!