From 717c7ff1f8670567f18f34c8d5ec2a0a542f32f0 Mon Sep 17 00:00:00 2001
From: "edward.safford" <edward.safford@noaa.gov>
Date: Thu, 4 Apr 2024 18:34:02 +0000
Subject: [PATCH] Ref #21

Add splitPlotYaml.py, updates for Jjob, ex script.
---
 ush/splitPlotYaml.py | 112 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 112 insertions(+)
 create mode 100644 ush/splitPlotYaml.py

diff --git a/ush/splitPlotYaml.py b/ush/splitPlotYaml.py
new file mode 100644
index 0000000..7459aba
--- /dev/null
+++ b/ush/splitPlotYaml.py
@@ -0,0 +1,112 @@
+#!/usr/bin/env python3
+# splitPlotYaml
+#
+# Parse input yaml plot file, break it into smaller yaml files
+# by satellite/instrument and for larger instruments, plot type.
+
+import argparse
+import yaml
+from eva.utilities.logger import Logger
+
+
+def removeKey(d, keys):
+    """
+    Remove keys from a dictionary 
+   
+    Parameters:
+        d (dict): input dictionary
+        keys (list): keys to remove from dictionary
+ 
+    Return:
+        modified dictionary if key(s) are found or input dictionary if no keys
+        are in input dictionary
+    """
+
+    r = dict(d)
+    for key in keys:
+        if key in d.keys():
+            del r[key]
+    return r
+
+
+
+if __name__ == "__main__":
+    """
+    splitPlotYaml
+
+    Read and parse input plot and channel data yaml files.  Extract the satellite data,
+    evaluate the number of channels for a given instrument and then create smaller yaml plot
+    files spliting by satellite/instrument or satellite/instrument/plot and keeping all
+    the additional data (model name, time interval, etc).
+
+    Example calling sequence: >python splitPlotYaml.py -i ../parm/gfs/gfs_plots.yaml 
+                                  -c ../parm/instrument_channels.py
+    """
+
+    logger = Logger('splitPlotYaml')
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument('-i', '--input', type=str, help='Input YAML plot file', required=True)
+    parser.add_argument('-c', '--chan', type=str, help='Input YAML instrument channel file', required=True)
+
+    args = parser.parse_args()
+    try:
+        mon_sources = args.input
+        with open(mon_sources, 'r') as mon_sources_opened:
+            mon_dict = yaml.safe_load(mon_sources_opened)
+    except Exception as e:
+        logger.abort('splitPlotYaml is expecting a valid model plot yaml file, but it encountered ' +
+                     f'errors when attempting to load: {mon_sources}, error: {e}')
+
+    try:
+        chan_data = args.chan
+        with open(chan_data, 'r') as chan_data_opened:
+            chan_dict = yaml.safe_load(chan_data_opened)
+    except Exception as e:
+        logger.abort('plotObsMon is expecting a valid satellite channel file, but it encountered ' +
+                     f'errors when attempting to load: {chan_data}, error: {e}')
+
+    model = mon_dict.get('model')
+    cycle_interval = mon_dict.get('cycle_interval')
+    data = mon_dict.get('data')
+
+    if 'satellites' in mon_dict.keys(): 
+        sd = removeKey(mon_dict, ['minimization', 'observations'])
+
+        for sat in mon_dict.get('satellites'):
+            satname = sat.get('name')
+
+            for inst in sat.get('instruments'):
+                iname = inst.get('name')
+                plist = inst.get('plot_list')
+
+                #---------------------------------------------------------------------
+                # For instruments with a large number of channels split the plot_list
+                #
+                channels = chan_dict.get(iname)
+                nchans = 0
+                if channels is not None:
+                    nchans = len(channels.split(","))
+
+                if nchans > 100:
+                    ctr=0
+                    for pl in inst.get('plot_list'):
+                        pd = sd
+                        pd['satellites'] = [{'name': satname, 
+                                             'instruments': [{'name': iname,
+                                                              'plot_list': [pl]}]}]
+                        fname = f'sat_{satname}_{iname}_{ctr}.yaml'
+                        file=open(fname,"w")
+                        yaml.dump(pd,file)
+                        file.close()                    
+                        ctr+=1
+ 
+                else: 
+                    pd = sd 
+                    pd['satellites'] = [{'name': satname, 
+                                         'instruments': [{'name': iname,
+                                                          'plot_list': plist}]}]
+                    fname = f'sat_{satname}_{iname}.yaml'
+                    file=open(fname,"w")
+                    yaml.dump(pd,file)
+                    file.close()