Merge pull request #222 from HARPgroup/develop-allops

Throw error when elements appear in SPEC-ACTIONS but not in OPSEQ

Author: PaulDudaRESPEC

examples/state_specl_ops/check_main.py

@@ -0,0 +1,37 @@
+# Bare bones cli tester - must be run from the HSPsquared source directory
+fpath = "./tests/testcbp/HSP2results/JL1_6562_6560.h5"
+
+from hsp2.hsp2.main import *
+from hsp2.hsp2.om import *
+from hsp2.hsp2io.hdf import HDF5
+from hsp2.hsp2io.io import IOManager
+from hsp2.state.state import *
+
+# sets up the model plumbing and reads parameters
+with HDF5(fpath) as hdf5_instance:
+    # Note: now that the UCI is read in and hdf5 loaded, you can see things like:
+    # - hdf5_instance._store.keys() - all the paths in the UCI/hdf5
+    io_manager = IOManager(hdf5_instance)
+    parameter_obj = io_manager.read_parameters()
+
+siminfo = parameter_obj.siminfo
+opseq = parameter_obj.opseq
+# - finally stash specactions in state, not domain (segment) dependent so do it once
+# now load state and the special actions
+state = init_state_dicts()
+state_siminfo_hsp2(parameter_obj, siminfo, io_manager, state)
+# Add support for dynamic functions to operate on STATE
+# - Load any dynamic components if present, and store variables on objects
+state_load_dynamics_hsp2(state, io_manager, siminfo)
+# Iterate through all segments and add crucial paths to state
+# before loading dynamic components that may reference them
+state_init_hsp2(state, opseq, activities)
+# - finally stash specactions in state, not domain (segment) dependent so do it once
+state["specactions"] = parameter_obj.specactions  # stash the specaction dict in state
+om_init_state(state)  # set up operational model specific state entries
+specl_load_state(state, parameter_obj)  # traditional special actions
+state_load_dynamics_om(
+    state, io_manager, siminfo
+)  # operational model for custom python
+# finalize all dynamically loaded components and prepare to run the model
+state_om_model_run_prep(state, io_manager, siminfo)

examples/state_specl_ops/demo_equation_cli.py

@@ -7,16 +7,32 @@
 """
 
 from numba import njit
+from hsp2.hsp2tools.names import hsp2_sequence_id
+import warnings
 
-
-def specl_load_om(state, io_manager, siminfo):
+def specl_load_om(state, parameter_obj):
+    active_segs = list(zip(parameter_obj.opseq['OPERATION'], parameter_obj.opseq['SEGMENT']))
     if "ACTIONS" in state["specactions"]:
         dc = state["specactions"]["ACTIONS"]
         for ix in dc.index:
             # add the items to the state['model_data'] dict
             speca = dc[ix : (ix + 1)]
             # need to add a name attribute
             opname = "SPEC" + "ACTION" + str(ix)
+            segtype = speca['OPTYP'].iloc[0]
+            segno = speca['RANGE1'].iloc[0]
+            # must check to see if the action refers to an active OPSEQ segment
+            # since hsp* allows segments to be defined but not OPNed
+            id = hsp2_sequence_id(segtype, segno)
+            if (segtype, id) not in active_segs:
+                raise Exception(
+                    "HSP* ERROR - Missing/inactive segment " + segtype + " " + 
+                    segno + " referenced in SPECIAL ACTIONS. Quitting."
+                )
+#                warnings.warn(
+#                    "Missing/inactive segment" + id + "referenced.",
+#                    DeprecationWarning)
+#                continue
             state["model_data"][opname] = {}
             state["model_data"][opname]["name"] = opname
             for ik in speca.keys():
@@ -34,8 +50,8 @@ def specl_load_om(state, io_manager, siminfo):
     return
 
 
-def specl_load_state(state, io_manager, siminfo):
-    specl_load_om(state, io_manager, siminfo)
+def specl_load_state(state, parameter_obj):
+    specl_load_om(state, parameter_obj)
     # others defined below, like:
     # specl_load_uvnames(state, io_manager, siminfo)
     # ...

src/hsp2/hsp2/SPECL.py

@@ -98,7 +98,7 @@ def main(
     # - finally stash specactions in state, not domain (segment) dependent so do it once
     state["specactions"] = specactions  # stash the specaction dict in state
     om_init_state(state)  # set up operational model specific state entries
-    specl_load_state(state, io_manager, siminfo)  # traditional special actions
+    specl_load_state(state, parameter_obj)  # traditional special actions
     state_load_dynamics_om(
         state, io_manager, siminfo
     )  # operational model for custom python

src/hsp2/hsp2/main.py

@@ -0,0 +1,7 @@
+"""
+Functions that should create paths, combined names, etc. should go here
+"""
+
+def hsp2_sequence_id(activity, ix):
+    s = f"{activity[0]}{int(ix):03d}"
+    return(s)

src/hsp2/hsp2tools/names.py

@@ -9,6 +9,7 @@
 import pandas as pd
 
 from hsp2 import hsp2tools
+from hsp2.hsp2tools.names import hsp2_sequence_id
 from hsp2.hsp2tools.uci_parse_specactions import specactions_parse
 
 pd.set_option("io.hdf.default_format", "table")
@@ -530,7 +531,7 @@ def opn(info, lines):
             s = tokens[2].split(":")
             indelt = int(s[0]) if len(s) == 1 else 60 * int(s[0]) + int(s[1])
         elif tokens[0] in ops:
-            s = f"{tokens[0][0]}{int(tokens[1]):03d}"
+            s = hsp2_sequence_id(tokens[0][0], tokens[1])
             lst.append((tokens[0], s, indelt))
     dfopn = pd.DataFrame(lst, columns=["OPERATION", "SEGMENT", "INDELT_minutes"])
     dfopn.to_hdf(store, key="/CONTROL/OP_SEQUENCE", data_columns=True)

src/hsp2/hsp2tools/readUCI.py

@@ -1,80 +1,41 @@
-# Must be run from the HSPsquared source directory, the h5 file has already been setup with hsp import_uci test10.uci
-# bare bones tester - must be run from the HSPsquared source directory
-import os
+# this is a simple tester that should be kept up to date with the code in main.py 
+# alternative to step debugger
+fpath = "./tests/testcbp/HSP2results/JL1_6562_6560.h5"
 
-import numpy
 from hsp2.hsp2.main import *
 from hsp2.hsp2.om import *
 from hsp2.hsp2io.hdf import HDF5
 from hsp2.hsp2io.io import IOManager
 from hsp2.state.state import *
 
-fpath = "./tests/testcbp/HSP2results/JL1_6562_6560.h5"
 # try also:
 # fpath = './tests/testcbp/HSP2results/JL1_6562_6560.h5'
 # sometimes when testing you may need to close the file, so try:
 # f = h5py.File(fpath,'a') # use mode 'a' which allows read, write, modify
 # # f.close()
 hdf5_instance = HDF5(fpath)
 io_manager = IOManager(hdf5_instance)
-uci_obj = io_manager.read_uci()
-siminfo = uci_obj.siminfo
-opseq = uci_obj.opseq
+parameter_obj = io_manager.read_parameters()
+siminfo = parameter_obj.siminfo
+opseq = parameter_obj.opseq
 # Note: now that the UCI is read in and hdf5 loaded, you can see things like:
 # - hdf5_instance._store.keys() - all the paths in the UCI/hdf5
 # - finally stash specactions in state, not domain (segment) dependent so do it once
 # now load state and the special actions
 state = init_state_dicts()
-state_initialize_om(state)
-state["specactions"] = uci_obj.specactions  # stash the specaction dict in state
-
-state_siminfo_hsp2(uci_obj, siminfo)
+state_siminfo_hsp2(parameter_obj, siminfo, io_manager, state)
 # Add support for dynamic functions to operate on STATE
 # - Load any dynamic components if present, and store variables on objects
 state_load_dynamics_hsp2(state, io_manager, siminfo)
 # Iterate through all segments and add crucial paths to state
 # before loading dynamic components that may reference them
 state_init_hsp2(state, opseq, activities)
-state_load_dynamics_specl(state, io_manager, siminfo)  # traditional special actions
+# - finally stash specactions in state, not domain (segment) dependent so do it once
+state["specactions"] = specactions  # stash the specaction dict in state
+om_init_state(state)  # set up operational model specific state entries
+specl_load_state(state, io_manager, siminfo)  # traditional special actions
 state_load_dynamics_om(
     state, io_manager, siminfo
 )  # operational model for custom python
-state_om_model_run_prep(
-    state, io_manager, siminfo
-)  # this creates all objects from the UCI and previous loads
-# state['model_root_object'].find_var_path('RCHRES_R001')
-# Get the timeseries naked, without an object
-Rlocal = state["model_object_cache"]["/STATE/RCHRES_R001/Rlocal"]
-Rlocal_ts = Rlocal.read_ts()
-rchres1 = state["model_object_cache"]["/STATE/RCHRES_R001"]
-Rlocal_check = ModelLinkage(
-    "Rlocal1", rchres1, {"right_path": "/TIMESERIES/TS010", "link_type": 3}
-)
-# Calls:
-# - ts = Rlocal.io_manager.read_ts(Category.INPUTS, None, Rlocal.ts_name)
-# - ts = transform(ts, Rlocal.ts_name, 'SAME', Rlocal.siminfo)
-Rlocal.io_manager._output._store.keys()
-# write it back.  We can give an arbitrary name or it will default to write back to the source path in right_path variable
-ts1 = (
-    precip_ts.read_ts()
-)  # same as precip_ts.ts_ix[precip_ts.ix], same as state['ts_ix'][precip_ts.ix]
-# we can specify a custom path to write this TS to
-precip_ts.write_path = "/RESULTS/test_TS039"
-precip_ts.write_ts()
-# precip_ts.write_ts is same as:
-#     ts4 = precip_ts.format_ts(ts1, ['tsvalue'], siminfo['tindex'])
-#     ts4.to_hdf(precip_ts.io_manager._output._store, precip_ts.write_path, format='t', data_columns=True, complevel=precip_ts.complevel)
-
-start = time.time()
-iterate_models(
-    model_exec_list, op_tokens, state_ix, dict_ix, ts_ix, siminfo["steps"], -1
-)
-end = time.time()
-print(
-    len(model_exec_list),
-    "components iterated over state_ix",
-    siminfo["steps"],
-    "time steps took",
-    end - start,
-    "seconds",
-)
+# finalize all dynamically loaded components and prepare to run the model
+state_om_model_run_prep(state, io_manager, siminfo)