Update loop_pairing header another time

NOAA-CSL · Mar 18, 2024 · 9b8a328 · 9b8a328
1 parent 9de372d
commit 9b8a328
Showing 1 changed file with 18 additions and 19 deletions.
diff --git a/melodies_monet/util/tools.py b/melodies_monet/util/tools.py
@@ -400,36 +400,35 @@ def find_obs_time_bounds(files=[],time_var=None):
     return bounds
 
 def loop_pairing(control,file_pairs_yaml='',file_pairs={},save_types=['paired']):
-
     """Function to loop over sets of pairings and save them out as multiple netcdf files.
-
+    
     Parameters
     ----------
     control : str
         str containing path to control file.
-        
+    
     file_pairs : dict (optional)
         Dict containing filenames for obs and models. This should be specified if file_pairs_yaml is not. 
-        Example: file_pairs = {'0722':{'model':{'wrfchem_v4.2':'/wrk/users/charkins/melodies-monet_data/wrfchem/run_CONUS_fv19_BEIS_1.0xISO_RACM_v4.2.2_racm_berk_vcp_noI_phot/0722/*'},
+        Example:
+            file_pairs = {'0722':{'model':{'wrfchem_v4.2':'/wrk/users/charkins/melodies-monet_data/wrfchem/run_CONUS_fv19_BEIS_1.0xISO_RACM_v4.2.2_racm_berk_vcp_noI_phot/0722/*'},
                       'obs':{'firexaq':'/wrk/d2/rschwantes/obs/firex-aq/R1/10s_merge/firexaq-mrg10-dc8_merge_20190722_R1.ict'}},
             '0905':{'model':{'wrfchem_v4.2':'/wrk/users/charkins/melodies-monet_data/wrfchem/run_CONUS_fv19_BEIS_1.0xISO_RACM_v4.2.2_racm_berk_vcp_noI_phot_soa/0905/*'},
-                    'obs':{'firexaq':'/wrk/d2/rschwantes/obs/firex-aq/R1/10s_merge/firexaq-mrg10-dc8_merge_20190905_R1.ict'}}
-            }
+                    'obs':{'firexaq':'/wrk/d2/rschwantes/obs/firex-aq/R1/10s_merge/firexaq-mrg10-dc8_merge_20190905_R1.ict'}}}
     
-    file_pairs_yaml : str
+    file_pairs_yaml : str (optional)
         str containing path to a yaml file with file pairings. 
-        Example below
-        '0722':
-          'model':
-            'wrfchem_v4.2':'/wrk/users/charkins/melodies-monet_data/wrfchem/run_CONUS_fv19_BEIS_1.0xISO_RACM_v4.2.2_racm_berk_vcp_noI_phot/0722/*'
-          'obs':
-            'firexaq':'/wrk/d2/rschwantes/obs/firex-aq/R1/10s_merge/firexaq-mrg10-dc8_merge_20190722_R1.ict'
-        '0905':
-           'model':
-            'wrfchem_v4.2':'/wrk/users/charkins/melodies-monet_data/wrfchem/run_CONUS_fv19_BEIS_1.0xISO_RACM_v4.2.2_racm_berk_vcp_noI_phot_soa/0905/*'
-          'obs':
-            'firexaq':'/wrk/d2/rschwantes/obs/firex-aq/R1/10s_merge/firexaq-mrg10-dc8_merge_20190905_R1.ict'
-     
+        Example:
+            '0722':
+              'model':
+                'wrfchem_v4.2':'/wrk/users/charkins/melodies-monet_data/wrfchem/run_CONUS_fv19_BEIS_1.0xISO_RACM_v4.2.2_racm_berk_vcp_noI_phot/0722/*'
+              'obs':
+                'firexaq':'/wrk/d2/rschwantes/obs/firex-aq/R1/10s_merge/firexaq-mrg10-dc8_merge_20190722_R1.ict'
+            '0905':
+               'model':
+                'wrfchem_v4.2':'/wrk/users/charkins/melodies-monet_data/wrfchem/run_CONUS_fv19_BEIS_1.0xISO_RACM_v4.2.2_racm_berk_vcp_noI_phot_soa/0905/*'
+              'obs':
+                'firexaq':'/wrk/d2/rschwantes/obs/firex-aq/R1/10s_merge/firexaq-mrg10-dc8_merge_20190905_R1.ict'
+    
     save_types : list (optional)
         List containing the types of data to save to netcdf. Can include any of 'paired', 'models', and 'obs'