#474: LFRic-Nudging: Part-A: Introduce ability to read nudging datafiles

applications/adjoint_tests/rose-meta/lfric-adjoint_tests/versions.py

@@ -880,3 +880,55 @@ def upgrade(self, config, meta_config=None):
         )
 
         return config, self.reports
+
+
+class vn31_t474(MacroUpgrade):
+    """Upgrade macro for ticket #474 by Mohit Dalvi."""
+
+    BEFORE_TAG = "vn3.1_t401"
+    AFTER_TAG = "vn3.1_t474"
+
+    def upgrade(self, config, meta_config=None):
+        # Commands From: rose-meta/lfric-gungho
+        self.add_setting(config, ["namelist:files", "nudging_directory"], "''")
+        self.add_setting(config, ["namelist:files", "nudging_filename"], "''")
+        self.add_setting(
+            config,
+            ["namelist:multires_coupling", "coarse_nudging"],
+            ".false.",
+        )
+        self.add_setting(
+            config, ["namelist:multires_coupling", "nudging_mesh_name"], "''"
+        )
+        # Add new nudging namelist -with sensible default values
+        # Append after 'multires_coupling' in configuration.nml
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        source = re.sub(
+            r"(namelist:multires_coupling)",
+            r"namelist:multires_coupling)" + "\n" + " (namelist:nudging",
+            source,
+        )
+        self.change_setting_value(
+            config, ["file:configuration.nml", "source"], source
+        )
+        self.add_setting(config, ["namelist:nudging"])
+        self.add_setting(
+            config, ["namelist:nudging", "nudge_data_levels"], "137"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_bottom"], "5"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_top"], "52"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_source"], "'era'"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_width_bottom"], "1"
+        )
+        self.add_setting(config, ["namelist:nudging", "nudging_width_top"], "0")
+
+        return config, self.reports

applications/gravity_wave/rose-meta/lfric-gravity_wave/versions.py

@@ -845,3 +845,55 @@ def upgrade(self, config, meta_config=None):
         )
 
         return config, self.reports
+
+
+class vn31_t474(MacroUpgrade):
+    """Upgrade macro for ticket #474 by Mohit Dalvi."""
+
+    BEFORE_TAG = "vn3.1_t401"
+    AFTER_TAG = "vn3.1_t474"
+
+    def upgrade(self, config, meta_config=None):
+        # Commands From: rose-meta/lfric-gungho
+        self.add_setting(config, ["namelist:files", "nudging_directory"], "''")
+        self.add_setting(config, ["namelist:files", "nudging_filename"], "''")
+        self.add_setting(
+            config,
+            ["namelist:multires_coupling", "coarse_nudging"],
+            ".false.",
+        )
+        self.add_setting(
+            config, ["namelist:multires_coupling", "nudging_mesh_name"], "''"
+        )
+        # Add new nudging namelist -with sensible default values
+        # Append after 'multires_coupling' in configuration.nml
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        source = re.sub(
+            r"(namelist:multires_coupling)",
+            r"namelist:multires_coupling)" + "\n" + " (namelist:nudging",
+            source,
+        )
+        self.change_setting_value(
+            config, ["file:configuration.nml", "source"], source
+        )
+        self.add_setting(config, ["namelist:nudging"])
+        self.add_setting(
+            config, ["namelist:nudging", "nudge_data_levels"], "137"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_bottom"], "5"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_top"], "52"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_source"], "'era'"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_width_bottom"], "1"
+        )
+        self.add_setting(config, ["namelist:nudging", "nudging_width_top"], "0")
+
+        return config, self.reports

applications/gungho_model/rose-meta/lfric-gungho_model/versions.py

@@ -845,3 +845,55 @@ def upgrade(self, config, meta_config=None):
         )
 
         return config, self.reports
+
+
+class vn31_t474(MacroUpgrade):
+    """Upgrade macro for ticket #474 by Mohit Dalvi."""
+
+    BEFORE_TAG = "vn3.1_t401"
+    AFTER_TAG = "vn3.1_t474"
+
+    def upgrade(self, config, meta_config=None):
+        # Commands From: rose-meta/lfric-gungho
+        self.add_setting(config, ["namelist:files", "nudging_directory"], "''")
+        self.add_setting(config, ["namelist:files", "nudging_filename"], "''")
+        self.add_setting(
+            config,
+            ["namelist:multires_coupling", "coarse_nudging"],
+            ".false.",
+        )
+        self.add_setting(
+            config, ["namelist:multires_coupling", "nudging_mesh_name"], "''"
+        )
+        # Add new nudging namelist -with sensible default values
+        # Append after 'multires_coupling' in configuration.nml
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        source = re.sub(
+            r"(namelist:multires_coupling)",
+            r"namelist:multires_coupling)" + "\n" + " (namelist:nudging",
+            source,
+        )
+        self.change_setting_value(
+            config, ["file:configuration.nml", "source"], source
+        )
+        self.add_setting(config, ["namelist:nudging"])
+        self.add_setting(
+            config, ["namelist:nudging", "nudge_data_levels"], "137"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_bottom"], "5"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_top"], "52"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_source"], "'era'"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_width_bottom"], "1"
+        )
+        self.add_setting(config, ["namelist:nudging", "nudging_width_top"], "0")
+
+        return config, self.reports

applications/jedi_lfric_tests/rose-meta/jedi_common/versions.py

@@ -880,3 +880,55 @@ def upgrade(self, config, meta_config=None):
         )
 
         return config, self.reports
+
+
+class vn31_t474(MacroUpgrade):
+    """Upgrade macro for ticket #474 by Mohit Dalvi."""
+
+    BEFORE_TAG = "vn3.1_t401"
+    AFTER_TAG = "vn3.1_t474"
+
+    def upgrade(self, config, meta_config=None):
+        # Commands From: rose-meta/lfric-gungho
+        self.add_setting(config, ["namelist:files", "nudging_directory"], "''")
+        self.add_setting(config, ["namelist:files", "nudging_filename"], "''")
+        self.add_setting(
+            config,
+            ["namelist:multires_coupling", "coarse_nudging"],
+            ".false.",
+        )
+        self.add_setting(
+            config, ["namelist:multires_coupling", "nudging_mesh_name"], "''"
+        )
+        # Add new nudging namelist -with sensible default values
+        # Append after 'multires_coupling' in configuration.nml
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        source = re.sub(
+            r"(namelist:multires_coupling)",
+            r"namelist:multires_coupling)" + "\n" + " (namelist:nudging",
+            source,
+        )
+        self.change_setting_value(
+            config, ["file:configuration.nml", "source"], source
+        )
+        self.add_setting(config, ["namelist:nudging"])
+        self.add_setting(
+            config, ["namelist:nudging", "nudge_data_levels"], "137"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_bottom"], "5"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_top"], "52"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_source"], "'era'"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_width_bottom"], "1"
+        )
+        self.add_setting(config, ["namelist:nudging", "nudging_width_top"], "0")
+
+        return config, self.reports

applications/jedi_lfric_tests/rose-meta/jedi_forecast/versions.py

@@ -880,3 +880,55 @@ def upgrade(self, config, meta_config=None):
         )
 
         return config, self.reports
+
+
+class vn31_t474(MacroUpgrade):
+    """Upgrade macro for ticket #474 by Mohit Dalvi."""
+
+    BEFORE_TAG = "vn3.1_t401"
+    AFTER_TAG = "vn3.1_t474"
+
+    def upgrade(self, config, meta_config=None):
+        # Commands From: rose-meta/lfric-gungho
+        self.add_setting(config, ["namelist:files", "nudging_directory"], "''")
+        self.add_setting(config, ["namelist:files", "nudging_filename"], "''")
+        self.add_setting(
+            config,
+            ["namelist:multires_coupling", "coarse_nudging"],
+            ".false.",
+        )
+        self.add_setting(
+            config, ["namelist:multires_coupling", "nudging_mesh_name"], "''"
+        )
+        # Add new nudging namelist -with sensible default values
+        # Append after 'multires_coupling' in configuration.nml
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        source = re.sub(
+            r"(namelist:multires_coupling)",
+            r"namelist:multires_coupling)" + "\n" + " (namelist:nudging",
+            source,
+        )
+        self.change_setting_value(
+            config, ["file:configuration.nml", "source"], source
+        )
+        self.add_setting(config, ["namelist:nudging"])
+        self.add_setting(
+            config, ["namelist:nudging", "nudge_data_levels"], "137"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_bottom"], "5"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_top"], "52"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_source"], "'era'"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_width_bottom"], "1"
+        )
+        self.add_setting(config, ["namelist:nudging", "nudging_width_top"], "0")
+
+        return config, self.reports

applications/jedi_lfric_tests/rose-meta/jedi_forecast_pseudo/versions.py

@@ -880,3 +880,55 @@ def upgrade(self, config, meta_config=None):
         )
 
         return config, self.reports
+
+
+class vn31_t474(MacroUpgrade):
+    """Upgrade macro for ticket #474 by Mohit Dalvi."""
+
+    BEFORE_TAG = "vn3.1_t401"
+    AFTER_TAG = "vn3.1_t474"
+
+    def upgrade(self, config, meta_config=None):
+        # Commands From: rose-meta/lfric-gungho
+        self.add_setting(config, ["namelist:files", "nudging_directory"], "''")
+        self.add_setting(config, ["namelist:files", "nudging_filename"], "''")
+        self.add_setting(
+            config,
+            ["namelist:multires_coupling", "coarse_nudging"],
+            ".false.",
+        )
+        self.add_setting(
+            config, ["namelist:multires_coupling", "nudging_mesh_name"], "''"
+        )
+        # Add new nudging namelist -with sensible default values
+        # Append after 'multires_coupling' in configuration.nml
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        source = re.sub(
+            r"(namelist:multires_coupling)",
+            r"namelist:multires_coupling)" + "\n" + " (namelist:nudging",
+            source,
+        )
+        self.change_setting_value(
+            config, ["file:configuration.nml", "source"], source
+        )
+        self.add_setting(config, ["namelist:nudging"])
+        self.add_setting(
+            config, ["namelist:nudging", "nudge_data_levels"], "137"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_bottom"], "5"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_top"], "52"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_source"], "'era'"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_width_bottom"], "1"
+        )
+        self.add_setting(config, ["namelist:nudging", "nudging_width_top"], "0")
+
+        return config, self.reports

applications/jedi_lfric_tests/rose-meta/jedi_id_tlm_tests/versions.py

@@ -880,3 +880,55 @@ def upgrade(self, config, meta_config=None):
         )
 
         return config, self.reports
+
+
+class vn31_t474(MacroUpgrade):
+    """Upgrade macro for ticket #474 by Mohit Dalvi."""
+
+    BEFORE_TAG = "vn3.1_t401"
+    AFTER_TAG = "vn3.1_t474"
+
+    def upgrade(self, config, meta_config=None):
+        # Commands From: rose-meta/lfric-gungho
+        self.add_setting(config, ["namelist:files", "nudging_directory"], "''")
+        self.add_setting(config, ["namelist:files", "nudging_filename"], "''")
+        self.add_setting(
+            config,
+            ["namelist:multires_coupling", "coarse_nudging"],
+            ".false.",
+        )
+        self.add_setting(
+            config, ["namelist:multires_coupling", "nudging_mesh_name"], "''"
+        )
+        # Add new nudging namelist -with sensible default values
+        # Append after 'multires_coupling' in configuration.nml
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        source = re.sub(
+            r"(namelist:multires_coupling)",
+            r"namelist:multires_coupling)" + "\n" + " (namelist:nudging",
+            source,
+        )
+        self.change_setting_value(
+            config, ["file:configuration.nml", "source"], source
+        )
+        self.add_setting(config, ["namelist:nudging"])
+        self.add_setting(
+            config, ["namelist:nudging", "nudge_data_levels"], "137"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_bottom"], "5"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_level_top"], "52"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_source"], "'era'"
+        )
+        self.add_setting(
+            config, ["namelist:nudging", "nudging_width_bottom"], "1"
+        )
+        self.add_setting(config, ["namelist:nudging", "nudging_width_top"], "0")
+
+        return config, self.reports