Specify met_forcings key as a dictionary

Changes requested by @ccarouge: #136 (comment)

Author: SeanBryan51

benchcab/data/config-schema.yml

@@ -80,18 +80,13 @@ spatial:
   required: false
   schema:
     met_forcings:
-      type: "list"
+      type: "dict"
       required: false
-      schema:
-        type: "dict"
-        required: true
-        schema:
-          name:
-            type: "string"
-            required: true
-          payu_experiment:
-            type: "string"
-            required: true
+      minlength: 1
+      keysrules:
+        type: "string"
+      valuesrules:
+        type: "string"
     payu:
       type: "dict"
       required: false

benchcab/internal.py

@@ -90,15 +90,12 @@
 # Path to PLUMBER2 site forcing data directory (doi: 10.25914/5fdb0902607e1):
 MET_DIR = Path("/g/data/ks32/CLEX_Data/PLUMBER2/v1-0/Met/")
 
-# List of default met forcings to use in the spatial test suite. Each met
+# Default met forcings to use in the spatial test suite. Each met
 # forcing has a corresponding payu experiment that is configured to run CABLE
 # with that forcing.
-SPATIAL_DEFAULT_MET_FORCINGS = [
-    {
-        "name": "crujra_access",
-        "payu_experiment": "https://github.com/CABLE-LSM/cable_example.git",
-    }
-]
+SPATIAL_DEFAULT_MET_FORCINGS = {
+    "crujra_access": "https://github.com/CABLE-LSM/cable_example.git",
+}
 
 # CABLE SVN root url:
 CABLE_SVN_ROOT = "https://trac.nci.org.au/svn/cable"

benchcab/spatial.py

@@ -148,22 +148,22 @@ def run_tasks(tasks: list[SpatialTask], verbose=False):
 
 def get_spatial_tasks(
     repos: list[CableRepository],
-    met_forcings: list[dict[str, str]],
+    met_forcings: dict[str, str],
     science_configurations: list[dict],
     payu_args: Optional[str] = None,
 ):
     """Returns a list of spatial tasks to run."""
     tasks = [
         SpatialTask(
             repo=repo,
-            met_forcing_name=met_forcing["name"],
-            met_forcing_payu_experiment=met_forcing["payu_experiment"],
+            met_forcing_name=met_forcing_name,
+            met_forcing_payu_experiment=met_forcing_payu_experiment,
             sci_conf_id=sci_conf_id,
             sci_config=sci_config,
             payu_args=payu_args,
         )
         for repo in repos
-        for met_forcing in met_forcings
+        for met_forcing_name, met_forcing_payu_experiment in met_forcings.items()
         for sci_conf_id, sci_config in enumerate(science_configurations)
     ]
     return tasks

tests/conftest.py

@@ -92,13 +92,10 @@ def config():
             "multiprocessing": True,
         },
         "spatial": {
-            "met_forcings": [
-                {
-                    "name": "crujra_access",
-                    "payu_experiment": "https://github.com/CABLE-LSM/cable_example.git",
-                },
-                {"name": "gswp", "payu_experiment": "foo"},
-            ],
+            "met_forcings": {
+                "crujra_access": "https://github.com/CABLE-LSM/cable_example.git",
+                "gswp": "foo",
+            },
             "payu": {
                 "config": {
                     "ncpus": 16,

tests/test_spatial.py

@@ -158,13 +158,10 @@ def repos(self, config):
     @pytest.fixture()
     def met_forcings(self):
         """Return a list of spatial met forcing specifications."""
-        return [
-            {
-                "name": "crujra_access",
-                "payu_experiment": "https://github.com/CABLE-LSM/cable_example.git",
-            },
-            {"name": "gswp", "payu_experiment": "foo"},
-        ]
+        return {
+            "crujra_access": "https://github.com/CABLE-LSM/cable_example.git",
+            "gswp": "foo",
+        }
 
     @pytest.fixture()
     def science_configurations(self, config):
@@ -180,15 +177,16 @@ def test_task_product_across_branches_forcings_and_configurations(
             met_forcings=met_forcings,
             science_configurations=science_configurations,
         )
+        met_forcing_names = list(met_forcings.keys())
         assert [
             (task.repo, task.met_forcing_name, task.sci_config) for task in tasks
         ] == [
-            (repos[0], met_forcings[0]["name"], science_configurations[0]),
-            (repos[0], met_forcings[0]["name"], science_configurations[1]),
-            (repos[0], met_forcings[1]["name"], science_configurations[0]),
-            (repos[0], met_forcings[1]["name"], science_configurations[1]),
-            (repos[1], met_forcings[0]["name"], science_configurations[0]),
-            (repos[1], met_forcings[0]["name"], science_configurations[1]),
-            (repos[1], met_forcings[1]["name"], science_configurations[0]),
-            (repos[1], met_forcings[1]["name"], science_configurations[1]),
+            (repos[0], met_forcing_names[0], science_configurations[0]),
+            (repos[0], met_forcing_names[0], science_configurations[1]),
+            (repos[0], met_forcing_names[1], science_configurations[0]),
+            (repos[0], met_forcing_names[1], science_configurations[1]),
+            (repos[1], met_forcing_names[0], science_configurations[0]),
+            (repos[1], met_forcing_names[0], science_configurations[1]),
+            (repos[1], met_forcing_names[1], science_configurations[0]),
+            (repos[1], met_forcing_names[1], science_configurations[1]),
         ]