Refactor wet model drivers and controllers

Coupled_Drivers/common.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 '''
 *****************************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,8 +18,6 @@
     Common functions and classes required by multiple model drivers
 '''
 
-
-
 import datetime
 import glob
 import shutil
@@ -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):
@@ -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,12 @@ def remove_file(filename):
     else:
         return False
 
+def remove_trailing_slash(path_str):
+    """
+    Remove any trailing slashes and whitespace from the path string.
+    """
+    return path_str.rstrip(' \t\n\r/')
+
 def setup_runtime(common_env):
     '''
     Set up model run length in seconds based on the model suite

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,11 +18,11 @@
     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_NL': {'default_val': 'namelist_ice_cfg'}}
-
+SI3_ENVIRONMENT_VARS_FINAL = SI3_ENVIRONMENT_VARS_COMMON
 TOP_ENVIRONMENT_VARS_COMMON = {
     'TOP_NL': {'default_val': 'namelist_top_cfg'}}
 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
@@ -53,6 +53,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 +142,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
 

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 Utilities/NGMS_utils/ngms_namcouple_gen Utilities/NGMS_utils/ngms_suite_lib
 
-$install_common=
+$install_common =
 
 build.target = $install_common

Coupled_Drivers/link_drivers

@@ -1,7 +1,7 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 '''
 *****************************COPYRIGHT******************************
- (C) Crown copyright 2023-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
@@ -19,19 +19,24 @@ DESCRIPTION
     to run a given configuration
 '''
 
-
+#The from __future__ imports ensure compatibility between python2.7 and 3.x
+from __future__ import absolute_import
 import importlib
 import sys
 import os
 import argparse
 import error
 import common
+import write_namcouple
 import dr_env_lib.common_def
 import dr_env_lib.env_lib
 
 #A tuple for for the earlist version of python required to run the drivers
 REQUIRED_VERSION = (3, 6)
 
+# A submodel is a model which runs within another model, and doesnt require its # own driver or controller, for example si3 is a submodel of NEMO
+SUBMODELS = ['si3', 'top']
+
 def _check_drivers(models):
     '''
     Takes in our space separated list of models, and ensure that a driver is
@@ -138,8 +143,6 @@ def _export_cmd_str(launchcmds, common_env):
 
 
 
-
-
 if __name__ == '__main__':
     # Owing to the limitations of the MPI launchers and passing information
     # between the shell and the python drivers, prepare two command files, one