Refactor wet model drivers and controllers

Co-authored-by: harry-shepherd <17930806+harry-shepherd@users.noreply.github.com>

Author: Pierre-siddall

Coupled_Drivers/common.py

@@ -1,7 +1,7 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 '''
 *****************************COPYRIGHT******************************
- (C) Crown copyright 2022-2025 Met Office. All rights reserved.
+ (C) Crown copyright 2021 Met Office. All rights reserved.
 
  Use, duplication or disclosure of this code is subject to the restrictions
  as set forth in the licence. If no licence has been raised with this copy
@@ -18,11 +18,9 @@
     Common functions and classes required by multiple model drivers
 '''
 
-
-
-import datetime
-import glob
-import shutil
+#The from __future__ imports ensure compatibility between python2.7 and 3.x
+from __future__ import absolute_import
+import copy
 import re
 import os
 import sys
@@ -32,7 +30,6 @@
 import error
 import inc_days
 
-
 class ModNamelist(object):
     '''
     Modify a fortran namelist. This will not add any new variables, only
@@ -49,7 +46,7 @@ def __init__(self, filename):
     def var_val(self, variable, value):
         '''
         Create a container of variable name, value pairs to be updated. Note
-        that if a variable doesn't exist in the namelist file, then it
+        that if a variable doesn't exisit in the namelist file, then it
         will be ignored
         '''
         if isinstance(value, str):
@@ -83,7 +80,7 @@ def find_previous_workdir(cyclepoint, workdir, taskname, task_param_run=None):
     '''
     Find the work directory for the previous cycle. Takes as argument
     the current cyclepoint, the path to the current work directory, and
-    the current taskname, a value specifying multiple tasks within
+    the current taskname, a value specifying multiple tasks within 
     same cycle (e.g. coupled_run1, coupled_run2) as used in coupled NWP
     and returns an absolute path.
     '''
@@ -100,7 +97,7 @@ def find_previous_workdir(cyclepoint, workdir, taskname, task_param_run=None):
 
         return previous_workdir
 
-    else:
+    else:      
         cyclesdir = os.sep.join(workdir.split(os.sep)[:-2])
         #find the work directory for the previous cycle
         work_cycles = os.listdir(cyclesdir)
@@ -121,7 +118,7 @@ def find_previous_workdir(cyclepoint, workdir, taskname, task_param_run=None):
             sys.stderr.write('[FAIL] Can not find previous work directory for'
                              ' task %s\n' % taskname)
             sys.exit(error.MISSING_DRIVER_FILE_ERROR)
-
+    
         return os.path.join(cyclesdir, previous_task_cycle, taskname)
 
 
@@ -139,6 +136,7 @@ def get_filepaths(directory):
     return file_paths
 
 
+
 def open_text_file(name, mode):
     '''
     Provide a common function to open a file and provide a suitiable error
@@ -152,7 +150,7 @@ def open_text_file(name, mode):
              'a+':'updating (appending)'}
     if mode not in list(modes.keys()):
         options = ''
-        for k in modes:
+        for k in modes.keys():
             options += '  %s: %s\n' % (k, modes[k])
         sys.stderr.write('[FAIL] Attempting to open file %s, do not recognise'
                          ' mode %s. Please use one of the following modes:\n%s'
@@ -188,6 +186,28 @@ def remove_file(filename):
     else:
         return False
 
+def remove_trailing_slash(path_str):
+    '''
+    Takes a string of a path and removes any trailing slashes and spaces if
+    there are any present
+    '''
+    trailing_slash_regex = r'[\w/]*\w+([\s/]+)$'
+    match = re.match(trailing_slash_regex, path_str)
+    if match:
+        num_trailing_slashes = len(match.group(1))
+        return path_str[:-num_trailing_slashes]
+    return path_str
+        
+
+def remove_trailing_slash_orig(path_str):
+    '''
+    Takes a string of a path and removes the trailing slash if there is one
+    present
+    '''
+    if path_str[-1] == '/':
+        return path_str[:-1]
+    return path_str
+
 def setup_runtime(common_env):
     '''
     Set up model run length in seconds based on the model suite
@@ -324,53 +344,3 @@ def set_aprun_options(nproc, nodes, ompthr, hyperthreads, ss):
         rose_launcher_preopts = "-ss " + rose_launcher_preopts
 
     return rose_launcher_preopts
-
-
-def _sort_hist_dirs_by_date(dir_list):
-    '''
-    Sort a list of history directories by date
-    '''
-    # Pattern that defines the name of the history directories,
-    # which contain a date of the form YYYYmmddHHMM.
-    pattern = r'\.(\d{12})'
-
-    try:
-        dir_list.sort(key=lambda dname: datetime.datetime.strptime(
-            re.search(pattern, dname).group(1), '%Y%m%d%H%M'))
-    except AttributeError:
-        msg = '[FAIL] Cannot order directories: %s' % " ".join(dir_list)
-        sys.stderr.write(msg)
-        sys.exit(error.IOERROR)
-
-    return dir_list
-
-
-def remove_latest_hist_dir(old_hist_dir):
-    '''
-    If a model task has failed, then removed the last created history
-    directory, before a new one is created, associated with the
-    re-attempt.
-    '''
-    # Replace the regex pattern that defines the history directory
-    # name (that contains a date of the format YYYYmmddHHMM) with a
-    # generic pattern so that we can perform the directory glob.
-    history_pattern = re.sub(
-        r'\.\d{12}', '.????????????', old_hist_dir)
-
-    # Find and sort the history directories, and delete
-    # the latest one, corresponding to the last entry in
-    # the list.
-    history_dirs = glob.glob(history_pattern)
-    history_dirs = _sort_hist_dirs_by_date(history_dirs)
-
-    msg = '[INFO] Found history directories: %s \n' % ' '.join(
-        history_dirs)
-    sys.stdout.write(msg)
-
-    latest_hist_dir = history_dirs[-1]
-    msg = ("[WARN] Re-attempting failed model step. \n"
-           "[WARN] Clearing out latest history \n"
-           "[WARN] directory %s. \n" % latest_hist_dir)
-    sys.stdout.write(msg)
-
-    shutil.rmtree(latest_hist_dir)

Coupled_Drivers/dr_env_lib/nemo_def.py

@@ -1,7 +1,7 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 '''
 *****************************COPYRIGHT******************************
- (C) Crown copyright 2021-2025 Met Office. All rights reserved.
+ (C) Crown copyright 2021 Met Office. All rights reserved.
 
  Use, duplication or disclosure of this code is subject to the restrictions
  as set forth in the licence. If no licence has been raised with this copy
@@ -22,18 +22,20 @@
 # Variables required for both initalise and finalise
 NEMO_ENVIRONMENT_VARS_COMMON = {
     'NEMO_NL': {'default_val': 'namelist_cfg'},
-    'L_OCN_PASS_TRC': {'default_val': 'false'}
+    'L_OCN_PASS_TRC': {'default_val': 'false'},
+    'NEMO_NPROC': {'desc': 'Number of NEMO processors'},
+    'RST_LINK_DIR': {'default_val': '.',
+                     'desc': 'Subdirectory of $CYCL_TASK_WORK_DIR containing' \
+                     ' ocean restart links'}
     }
 
 NEMO_ENVIRONMENT_VARS_INITIAL = {
     'OCEAN_EXEC': {'desc': ('Ocean executable (OCEAN_EXEC=<full path to'
                             ' exec>)')},
-    'NEMO_NPROC': {'desc': 'Number of NEMO processors'},
     'NEMO_IPROC': {'desc': 'Number of NEMO processors in the i direction'},
     'NEMO_JPROC': {'desc': 'Number of NEMO processors in the j direction'},
     'NEMO_VERSION': {},
     'OCEAN_LINK': {'default_val': 'ocean.exe'},
-    'OCN_RES': {'default_val': ''},
     'NEMO_NL': {'default_val': 'namelist_cfg'},
     'NEMO_START': {'default_val': ''},
     'NEMO_ICEBERGS_START': {'default_val': ''},

Coupled_Drivers/dr_env_lib/ocn_cont_def.py

@@ -1,7 +1,7 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 '''
 *****************************COPYRIGHT******************************
- (C) Crown copyright 2021-2025 Met Office. All rights reserved.
+ (C) Crown copyright 2021 Met Office. All rights reserved.
 
  Use, duplication or disclosure of this code is subject to the restrictions
  as set forth in the licence. If no licence has been raised with this copy
@@ -18,17 +18,17 @@
     Definition of the environment variables required for the ocean
     controllers
 '''
+SI3_ENVIRONMENT_VARS_COMMON = {'SI3_NL': {'default_val': 'namelist_ice_cfg'}}
+SI3_ENVIRONMENT_VARS_INITIAL = {'SI3_START': {'default_val': ''}}
 
-SI3_ENVIRONMENT_VARS_INITIAL = {
-    'SI3_START': {'default_val': ''},
-    'SI3_NL': {'default_val': 'namelist_ice_cfg'}}
+SI3_ENVIRONMENT_VARS_INITIAL = {**SI3_ENVIRONMENT_VARS_COMMON,
+                                **SI3_ENVIRONMENT_VARS_INITIAL}
+SI3_ENVIRONMENT_VARS_FINAL = SI3_ENVIRONMENT_VARS_COMMON
 
 TOP_ENVIRONMENT_VARS_COMMON = {
     'TOP_NL': {'default_val': 'namelist_top_cfg'}}
 TOP_ENVIRONMENT_VARS_INITIAL = {
-    'TOP_START': {'default_val': ''},
-    'CONTINUE': {'default_val': 'false'},
-    'CONTINUE_FROM_FAIL': {'default_val': 'false'}}
+    'TOP_START': {'default_val': ''}}
 
 TOP_ENVIRONMENT_VARS_INITIAL = {**TOP_ENVIRONMENT_VARS_COMMON,
                                 **TOP_ENVIRONMENT_VARS_INITIAL}

Coupled_Drivers/error.py

@@ -1,7 +1,7 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 '''
 *****************************COPYRIGHT******************************
- (C) Crown copyright 2021-2025 Met Office. All rights reserved.
+ (C) Crown copyright 2021 Met Office. All rights reserved.
 
  Use, duplication or disclosure of this code is subject to the restrictions
  as set forth in the licence. If no licence has been raised with this copy
@@ -23,9 +23,6 @@
 # Python errors
 VERSION_ERROR = 1
 
-# Import Error
-IMPORT_ERROR = 2
-
 # File I/O errors
 IOERROR = 100
 
@@ -53,6 +50,9 @@
 # Invalid argument to driver script
 INVALID_DRIVER_ARG_ERROR = 202
 
+# Missing file contents
+MISSING_FILE_CONTENTS_ERROR = 203
+
 # Missing file required by a controller
 MISSING_CONTROLLER_FILE_ERROR = 251
 
@@ -139,6 +139,9 @@
 # Unable to create remapping file for mapping type
 MISSING_RMP_MAPPING = 816
 
+# Size of 1D grid is unknown
+UNKNOWN_1D_GRID_SIZE = 817
+
 # Ocean resolution for Snr<->Jnr coupling is not specified
 NO_OCN_RESOL = 818
 
@@ -181,17 +184,11 @@
 # Not on ORCA grid
 NOT_ORCA_GRID = 833
 
-# Not declared ocean resolution when creating namcouple on fly after NEMO3.6
-NOT_DECLARE_OCN_RES = 834
-
-# Unknown ocean resolution
-UNKNOWN_OCN_RESOL = 835
-
 # Missing namelist oasis_ocn_send_nml from OASIS_OCN_SEND
-MISSING_OASIS_OCN_SEND_NML = 836
+MISSING_OASIS_OCN_SEND_NML = 834
 
 # Missing entry oasis_ocn_send from namelist oasis_ocn_send_nml
-MISSING_OASIS_OCN_SEND = 837
+MISSING_OASIS_OCN_SEND = 835
 
 # Missing OASIS send file for UM
 MISSING_OASIS_ATM_SEND = 840
@@ -257,15 +254,3 @@
 
 # Not found the coupling namelist in namelist_cfg
 MISSING_NAMSBC_CPL = 871
-
-# Missing the JULES river resolution namelist
-MISSING_RIVER_RESOL_NML = 872
-
-# Missing the JULES river resolution parameters
-MISSING_RIVER_RESOL = 873
-
-# Missing OASIS send file for JULES river
-MISSING_OASIS_RIV_SEND = 874
-
-# Missing namelist oasis_riv_send_nml from OASIS_RIV_SEND
-MISSING_OASIS_RIV_SEND_NML = 875

Coupled_Drivers/fcm_make/driver.cfg

@@ -14,8 +14,8 @@ extract.ns = drivers
 extract.location{primary}[drivers] = fcm:moci.xm
 extract.location[drivers] = $driver_base${driver_rev}
 extract.path-excl[drivers] = /
-extract.path-incl[drivers] = Coupled_Drivers Utilities/NGMS_utils/ngms_namcouple_gen Utilities/NGMS_utils/ngms_suite_lib 
+extract.path-incl[drivers] = Coupled_Drivers
 
-$install_common=
+$install_common = cice_driver.py common.py write_namcouple.py default_couplings.py error.py inc_days.py jnr_driver.py link_drivers mct_driver.py nemo_driver.py OASIS_fields run_model save_um_state.py time2days.py um_driver.py update_namcouple.py update_nemo_nl.py xios_driver.py plot_cpmip_summary.py cpmip_controller.py mct_validate.py ocn_lib.py nemo_runtime_namcouple.py nemo_driver.py
 
 build.target = $install_common