Merge remote-tracking branch 'origin/main' into feature/cdeps_updated

Author: uturuncoglu

docs/sections/user_guide/cli/drivers/esg_grid/index.rst

@@ -3,7 +3,7 @@
 
 .. include:: ../shared/idempotent.rst
 
-The ``uw`` mode for configuring and running the :ufs-utils:`regional_esg_grid<regional-esg-grid>` component.
+The ``uw`` mode for configuring and running the UFS Utils preprocessing component ``regional_esg_grid``. Documentation for this UFS Utils component is :ufs-utils:`here <regional-esg-grid>`.
 
 .. include:: help.rst
 

src/uwtools/drivers/driver.py

@@ -497,11 +497,13 @@ def _runscript(
 
         {execution}
         """
+        directives = scheduler.directives if scheduler else ""
+        initcmds = scheduler.initcmds if scheduler else []
         rs = dedent(template).format(
-            directives="\n".join(scheduler.directives if scheduler else ""),
+            directives="\n".join(directives),
             envcmds="\n".join(envcmds or []),
             envvars="\n".join([f"export {k}={v}" for k, v in (envvars or {}).items()]),
-            execution="\n".join(execution),
+            execution="\n".join([*initcmds, *execution]),
         )
         return re.sub(r"\n\n\n+", "\n\n", rs.strip())
 

src/uwtools/drivers/esg_grid.py

@@ -58,5 +58,12 @@ def driver_name(cls) -> str:
         """
         return STR.esggrid
 
+    @property
+    def output(self) -> dict[str, Path]:
+        """
+        Returns a description of the file(s) created when this component runs.
+        """
+        return {"path": self.rundir / "regional_grid.nc"}
+
 
 set_driver_docstring(ESGGrid)

src/uwtools/drivers/global_equiv_resol.py

@@ -47,6 +47,13 @@ def driver_name(cls) -> str:
         """
         return STR.globalequivresol
 
+    @property
+    def output(self) -> dict[str, Path]:
+        """
+        Returns a description of the file(s) created when this component runs.
+        """
+        return {"path": Path(self.config["input_grid_file"])}
+
     # Private helper methods
 
     @property

src/uwtools/drivers/make_hgrid.py

@@ -2,6 +2,8 @@
 A driver for make_hgrid.
 """
 
+from pathlib import Path
+
 from iotaa import tasks
 
 from uwtools.drivers.driver import DriverTimeInvariant
@@ -33,6 +35,14 @@ def driver_name(cls) -> str:
         """
         return STR.makehgrid
 
+    @property
+    def output(self) -> dict[str, Path]:
+        """
+        Returns a description of the file(s) created when this component runs.
+        """
+        grid_name = self.config["config"].get("grid_name", "horizontal_grid")
+        return {"path": (self.rundir / grid_name).with_suffix(".nc")}
+
     # Private helper methods
 
     @property

src/uwtools/drivers/make_solo_mosaic.py

@@ -4,12 +4,17 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from iotaa import tasks
 
 from uwtools.drivers.driver import DriverTimeInvariant
 from uwtools.drivers.support import set_driver_docstring
 from uwtools.strings import STR
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
 
 class MakeSoloMosaic(DriverTimeInvariant):
     """
@@ -26,6 +31,14 @@ def provisioned_rundir(self):
         yield self.taskname("provisioned run directory")
         yield self.runscript()
 
+    @property
+    def output(self) -> dict[str, Path]:
+        """
+        Returns a description of the file(s) created when this component runs.
+        """
+        mosaic_name = self.config["config"].get("mosaic_name", "mosaic")
+        return {"path": (self.rundir / mosaic_name).with_suffix(".nc")}
+
     # Public helper methods
 
     def taskname(self, suffix: str | None = None) -> str:

src/uwtools/scheduler.py

@@ -36,7 +36,8 @@ def directives(self) -> list[str]:
         """
         The resource-request scheduler directives.
         """
-        pre, sep = self._prefix, self._directive_separator
+        prefix, separator = self._prefix, self._directive_separator
+        sep = lambda val: "%s%s" % (val, "" if val.endswith("=") else separator)
         ds = []
         for key, value in self._processed_props.items():
             if key in self._forbidden_directives:
@@ -45,11 +46,11 @@ def directives(self) -> list[str]:
             if key in self._managed_directives:
                 switch = self._managed_directives[key]
                 if callable(switch) and (x := switch(value)) is not None:
-                    ds.append("%s %s" % (pre, x))
+                    ds.append("%s %s" % (prefix, x))
                 else:
-                    ds.append("%s %s%s%s" % (pre, switch, sep, value))
+                    ds.append("%s %s%s" % (prefix, sep(switch), value))
             else:
-                ds.append("%s %s%s%s" % (pre, key, sep, value))
+                ds.append("%s %s%s" % (prefix, sep(key), value))
         return sorted(ds)
 
     @staticmethod
@@ -71,6 +72,13 @@ def get_scheduler(props: Mapping) -> JobScheduler:
         msg = f"No 'scheduler' defined in {props}"
         raise UWConfigError(msg)
 
+    @property
+    def initcmds(self) -> list[str]:
+        """
+        Additional initialization commands a batch job must run.
+        """
+        return []
+
     def submit_job(self, runscript: Path, submit_file: Path | None = None) -> bool:
         """
         Submit a job to the scheduler.
@@ -210,6 +218,14 @@ class PBS(JobScheduler):
     Represents the PBS scheduler.
     """
 
+    @property
+    def initcmds(self) -> list[str]:
+        """
+        Additional initialization commands a PBS batch job must run.
+        """
+        rundir = self._props.get(_DirectivesOptional.RUNDIR)
+        return [f"cd {rundir}"] if rundir else []
+
     @property
     def _directive_separator(self) -> str:
         """
@@ -222,7 +238,7 @@ def _forbidden_directives(self) -> list[str]:
         """
         Directives that this scheduler does not support.
         """
-        return []
+        return [_DirectivesOptional.RUNDIR]
 
     @property
     def _managed_directives(self) -> dict[str, Any]:
@@ -273,11 +289,12 @@ def _processed_props(self) -> dict[str, Any]:
         """
         Pre-processed runscript directives.
         """
-        props = self._props
+        props = deepcopy(self._props)
         props.update(self._select(props))
         props.update(self._placement(props))
         props.pop(_DirectivesOptional.TASKS_PER_NODE, None)
         props.pop(_DirectivesOptional.NODES, None)
+        props.pop(_DirectivesOptional.RUNDIR, None)
         props.pop(_DirectivesOptional.THREADS, None)
         props.pop(_DirectivesOptional.MEMORY, None)
         props.pop("exclusive", None)

src/uwtools/tests/drivers/test_driver.py

@@ -540,10 +540,11 @@ def test_Driver__runscript(driverobj):
     export VAR1=1
     export VAR2=2
 
+    cd /path/to/rundir
     foo
     bar
     """
-    scheduler = Mock(directives=["#DIR --d1", "#DIR --d2"])
+    scheduler = Mock(directives=["#DIR --d1", "#DIR --d2"], initcmds=["cd /path/to/rundir"])
     assert (
         driverobj._runscript(
             execution=["foo", "bar"],

src/uwtools/tests/drivers/test_esg_grid.py

@@ -6,11 +6,10 @@
 from unittest.mock import patch
 
 import f90nml  # type: ignore[import-untyped]
-from pytest import fixture, mark, raises
+from pytest import fixture, mark
 
 from uwtools.drivers.driver import Driver
 from uwtools.drivers.esg_grid import ESGGrid
-from uwtools.exceptions import UWNotImplementedError
 
 # Fixtures
 
@@ -71,7 +70,6 @@ def driverobj(config):
         "_scheduler",
         "_validate",
         "_write_runscript",
-        "output",
         "run",
         "runscript",
         "taskname",
@@ -111,9 +109,7 @@ def test_ESGGrid_namelist_file_missing_base_file(driverobj, logged):
 
 
 def test_ESGGrid_output(driverobj):
-    with raises(UWNotImplementedError) as e:
-        assert driverobj.output
-    assert str(e.value) == "The output() method is not yet implemented for this driver"
+    assert driverobj.output["path"] == driverobj.rundir / "regional_grid.nc"
 
 
 def test_ESGGrid_provisioned_rundir(driverobj, ready_task):

src/uwtools/tests/drivers/test_global_equiv_resol.py

@@ -5,11 +5,10 @@
 from pathlib import Path
 from unittest.mock import patch
 
-from pytest import fixture, mark, raises
+from pytest import fixture, mark
 
 from uwtools.drivers.driver import Driver
 from uwtools.drivers.global_equiv_resol import GlobalEquivResol
-from uwtools.exceptions import UWNotImplementedError
 
 # Fixtures
 
@@ -55,7 +54,6 @@ def driverobj(config):
         "_scheduler",
         "_validate",
         "_write_runscript",
-        "output",
         "run",
         "runscript",
         "taskname",
@@ -78,9 +76,7 @@ def test_GlobalEquivResol_input_file(driverobj):
 
 
 def test_GlobalEquivResol_output(driverobj):
-    with raises(UWNotImplementedError) as e:
-        assert driverobj.output
-    assert str(e.value) == "The output() method is not yet implemented for this driver"
+    assert driverobj.output["path"] == Path(driverobj.config["input_grid_file"])
 
 
 def test_GlobalEquivResol_provisioned_rundir(driverobj, ready_task):