[Refactor | Feature] Introducing NDSL backend

.github/workflows/fv3_translate_tests.yaml

@@ -10,7 +10,10 @@ on:
 
 jobs:
   fv3_translate_tests:
-    uses: NOAA-GFDL/pyFV3/.github/workflows/translate.yaml@develop
+    # TODO
+    # restore once NDSL 2026.02.00 is released and pyFV3 is updated.
+    # uses: NOAA-GFDL/pyFV3/.github/workflows/translate.yaml@develop
+    uses: romanc/pyFV3/.github/workflows/translate.yaml@noop
     with:
       component_trigger: true
       component_name: NDSL

.github/workflows/pace_tests.yaml

@@ -10,7 +10,10 @@ on:
 
 jobs:
   pace_main_tests:
-    uses: NOAA-GFDL/pace/.github/workflows/main_unit_tests.yaml@develop
+    # TODO
+    # restore once NDSL 2026.02.00 is released and pace is updated.
+    # uses: NOAA-GFDL/pace/.github/workflows/main_unit_tests.yaml@develop
+    uses: romanc/pace/.github/workflows/main_unit_tests.yaml@noop
     with:
       component_trigger: true
       component_name: NDSL

.github/workflows/shield_tests.yaml

@@ -10,7 +10,10 @@ on:
 
 jobs:
   shield_translate_tests:
-    uses: NOAA-GFDL/pySHiELD/.github/workflows/translate.yaml@develop
+    # TODO
+    # restore once NDSL 2026.02.00 is released and pySHiELD is updated.
+    # uses: NOAA-GFDL/pySHiELD/.github/workflows/translate.yaml@develop
+    uses: romanc/pySHiELD/.github/workflows/translate.yaml@noop
     with:
       component_trigger: true
       component_name: NDSL

examples/mpi/zarr_monitor.py

@@ -12,6 +12,7 @@
     TilePartitioner,
     ZarrMonitor,
 )
+from ndsl.config import backend_python
 from ndsl.constants import I_DIM, J_DIM, K_DIM
 
 
@@ -20,9 +21,9 @@
 
 def get_example_state(time):
     sizer = SubtileGridSizer(
-        nx=48, ny=48, nz=70, n_halo=3, data_dimensions={}, backend="debug"
+        nx=48, ny=48, nz=70, n_halo=3, data_dimensions={}, backend=backend_python
     )
-    allocator = QuantityFactory(sizer, np)
+    allocator = QuantityFactory(sizer, backend=backend_python)
     air_temperature = allocator.zeros([I_DIM, J_DIM, K_DIM], units="degK")
     air_temperature.view[:] = np.random.randn(*air_temperature.extent)
     return {"time": time, "air_temperature": air_temperature}

ndsl/__init__.py

@@ -1,20 +1,14 @@
+# isort:skip_file
 from . import dsl  # isort:skip
 from .logging import ndsl_log  # isort:skip
 from .comm.communicator import CubedSphereCommunicator, TileCommunicator
 from .comm.local_comm import LocalComm
 from .comm.mpi import MPIComm
 from .comm.partitioner import CubedSpherePartitioner, TilePartitioner
+from .config.backend import Backend
 from .constants import ConstantVersions
 from .dsl.caches.codepath import FV3CodePath
-from .dsl.dace.dace_config import DaceConfig, DaCeOrchestration
-from .dsl.dace.orchestration import orchestrate, orchestrate_function
-from .dsl.dace.utils import (
-    ArrayReport,
-    DaCeProgress,
-    MaxBandwidthBenchmarkProgram,
-    StorageReport,
-)
-from .dsl.dace.wrapped_halo_exchange import WrappedHaloUpdater
+from .quantity import Quantity
 from .dsl.ndsl_runtime import NDSLRuntime
 from .dsl.stencil import FrozenStencil, GridIndexing, StencilFactory, TimingCollector
 from .dsl.stencil_config import CompilationConfig, RunMode, StencilConfig
@@ -25,14 +19,25 @@
 from .performance.collector import NullPerformanceCollector, PerformanceCollector
 from .performance.profiler import NullProfiler, Profiler
 from .performance.report import Experiment, Report, TimeReport
-from .quantity import Local, LocalState, Quantity, State
+from .quantity import Local, LocalState, State
 from .quantity.field_bundle import FieldBundle, FieldBundleType  # Break circular import
 from .types import Allocator
 from .utils import MetaEnumStr
 
+from .dsl.dace.wrapped_halo_exchange import WrappedHaloUpdater
+from .dsl.dace.utils import (
+    ArrayReport,
+    DaCeProgress,
+    MaxBandwidthBenchmarkProgram,
+    StorageReport,
+)
+from .dsl.dace.dace_config import DaceConfig, DaCeOrchestration
+from .dsl.dace.orchestration import orchestrate, orchestrate_function
+
 
 __all__ = [
     "dsl",
+    "Backend",
     "CubedSphereCommunicator",
     "TileCommunicator",
     "LocalComm",

ndsl/boilerplate.py

@@ -1,6 +1,7 @@
 import warnings
 
 from ndsl import (
+    Backend,
     CompilationConfig,
     DaceConfig,
     DaCeOrchestration,
@@ -14,14 +15,15 @@
     TileCommunicator,
     TilePartitioner,
 )
+from ndsl.config.backend import backend_cpu, backend_python
 
 
 def _get_factories(
     nx: int,
     ny: int,
     nz: int,
     nhalo: int,
-    backend: str,
+    backend: Backend,
     orchestration: DaCeOrchestration,
     topology: str,
 ) -> tuple[StencilFactory, QuantityFactory]:
@@ -91,14 +93,14 @@ def get_factories_single_tile_orchestrated(
     ny: int,
     nz: int,
     nhalo: int,
-    backend: str = "dace:cpu",
+    backend: Backend = backend_cpu,
     *,
     orchestration_mode: DaCeOrchestration | None = None,
 ) -> tuple[StencilFactory, QuantityFactory]:
     """Build the pair of (StencilFactory, QuantityFactory) for orchestrated code on a single tile topology."""
 
-    if backend is not None and not backend.startswith("dace"):
-        raise ValueError("Only `dace:*` backends can be orchestrated.")
+    if backend is not None and not backend.is_orchestrated():
+        raise ValueError(f"Only `orch:*` backends can be orchestrated, got {backend}.")
 
     return _get_factories(
         nx=nx,
@@ -112,15 +114,17 @@ def get_factories_single_tile_orchestrated(
 
 
 def get_factories_single_tile(
-    nx: int, ny: int, nz: int, nhalo: int, backend: str = "numpy"
+    nx: int, ny: int, nz: int, nhalo: int, backend: Backend = backend_python
 ) -> tuple[StencilFactory, QuantityFactory]:
     """Build the pair of (StencilFactory, QuantityFactory) for stencils on a single tile topology."""
+    if not isinstance(backend, Backend):
+        raise RuntimeError(f"Backend {backend} is not of class Backend")
     return _get_factories(
         nx=nx,
         ny=ny,
         nz=nz,
         nhalo=nhalo,
         backend=backend,
-        orchestration=DaCeOrchestration.Python,
+        orchestration=DaCeOrchestration.BuildAndRun,
         topology="tile",
     )

ndsl/config/__init__.py

@@ -0,0 +1,22 @@
+from .backend import (
+    Backend,
+    BackendFramework,
+    BackendLoopOrder,
+    BackendStrategy,
+    BackendTargetDevice,
+    backend_cpu,
+    backend_gpu,
+    backend_python,
+)
+
+
+__all__ = [
+    "Backend",
+    "BackendFramework",
+    "BackendStrategy",
+    "BackendTargetDevice",
+    "BackendLoopOrder",
+    "backend_python",
+    "backend_cpu",
+    "backend_gpu",
+]