Extra ACCESS-OM2 QA metadata tests (#149)

* Add metadata model name tests to ACCESS-OM2 QA tests
* Add metadata notes test to ACCESS-OM2 QA tests to check for updated conditions of use

Author: jo-basevi

src/model_config_tests/config_tests/qa/test_access_om2_config.py

@@ -42,6 +42,20 @@
 ACCESS_OM2_REPOSITORY_NAME = "ACCESS-OM2"
 ACCESS_OM2_BGC_REPOSITORY_NAME = "ACCESS-OM2-BGC"
 
+# Expected metadata notes with conditions of use
+EXPECTED_METADATA_NOTES = """COSIMA request that users of this or other ACCESS-OM2 model code or output data:
+(a) add a project description to COSIMA's list:
+https://docs.google.com/spreadsheets/d/18BDyZlHTSy6EOaf_5o9CwGBOu4pBj88XsS2vNW4R_2o
+(b) consider citing Kiss et al. (2020) [http://doi.org/10.5194/gmd-13-401-2020] and papers describing relevant
+configuration updates - see https://forum.access-hive.org.au/t/access-om2-control-experiments/258
+(c) include an acknowledgement such as that suggested here: https://cosima.org.au/index.php/get-involved/
+(d) let COSIMA know of any publications which use these models or data so they can add them to their list:
+https://scholar.google.com/citations?hl=en&user=inVqu_4AAAAJ
+(e) Tell ACCESS-NRI that you are using ACCESS-NRI infrastructure: https://www.access-nri.org.au/resources/user-reporting/"""
+
+# Expected metadata model name
+EXPECTED_METADATA_MODEL = "ACCESS-OM2"
+
 
 class AccessOM2Branch:
     """Use the naming patterns of the branch name to infer information of
@@ -207,3 +221,13 @@ def test_access_om2_manifest_exe_in_release_spack_location(
             control_path=control_path,
             config=config,
         )
+
+    def test_access_om2_metadata_model(self, metadata):
+        assert (
+            "model" in metadata and metadata["model"] == EXPECTED_METADATA_MODEL
+        ), f"Expected metadata model field set to: {EXPECTED_METADATA_MODEL}"
+
+    def test_access_om2_metadata_notes(self, metadata):
+        assert "notes" in metadata and metadata["notes"] == EXPECTED_METADATA_NOTES, (
+            "Expected metadata notes field set to:\n" + EXPECTED_METADATA_NOTES
+        )

tests/resources/access-om2/configurations/dev-025deg_jra55_iaf_bgc/metadata.yaml

@@ -13,14 +13,14 @@ description: |-
   Spin up starts 1 Jan 1958 and runs to 1 Jan 2019.
 notes: |-
   COSIMA request that users of this or other ACCESS-OM2 model code or output data:
-  (a) consider citing Kiss et al. (2020) [http://doi.org/10.5194/gmd-13-401-2020]
-  (b) include an acknowledgement such as the following:
-  "The authors thank the Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA; http://www.cosima.org.au)
-  for making the ACCESS-OM2 suite of models available at https://github.com/COSIMA/access-om2.
-  Model runs were undertaken with the assistance of resources from the National Computational Infrastructure (NCI),
-  which is supported by the Australian Government."
-  (c) let COSIMA know of any publications which use these models or data so they can add them to their list:
+  (a) add a project description to COSIMA's list:
+  https://docs.google.com/spreadsheets/d/18BDyZlHTSy6EOaf_5o9CwGBOu4pBj88XsS2vNW4R_2o
+  (b) consider citing Kiss et al. (2020) [http://doi.org/10.5194/gmd-13-401-2020] and papers describing relevant
+  configuration updates - see https://forum.access-hive.org.au/t/access-om2-control-experiments/258
+  (c) include an acknowledgement such as that suggested here: https://cosima.org.au/index.php/get-involved/
+  (d) let COSIMA know of any publications which use these models or data so they can add them to their list:
   https://scholar.google.com/citations?hl=en&user=inVqu_4AAAAJ
+  (e) Tell ACCESS-NRI that you are using ACCESS-NRI infrastructure: https://www.access-nri.org.au/resources/user-reporting/
 keywords:
 - JRA55
 - access-om2-025

tests/resources/access-om2/configurations/release-1deg_jra55_ryf/metadata.yaml

@@ -4,14 +4,14 @@ created: Add the date you started the experiment here (YYYY-MM-DD)
 description: "1 degree ACCESS-OM2 global model configuration under the RYF9091 Repeat\nYear Forcing strategy outlined by Stewart et al. (2020), \nhttps://doi.org/10.1016/j.ocemod.2019.101557.\nThe configuration is based on that described in Kiss et al. (2020),\nhttps://doi.org/10.5194/gmd-13-401-2020, but with many improvements.\nInitial conditions are WOA13v2 potential temperature and practical salinity.\nRun with JRA55-do v1.4.0 RYF9091 (1 May 1990 - 30 April 1991) repeated forcing\nwith all solid runoff converted to liquid runoff with no heat transfer.\nSpin up starts from a nominal year of 1 Jan 1900."
 notes: |-
   COSIMA request that users of this or other ACCESS-OM2 model code or output data:
-  (a) consider citing Kiss et al. (2020) [http://doi.org/10.5194/gmd-13-401-2020]
-  (b) include an acknowledgement such as the following:
-  "The authors thank the Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA; http://www.cosima.org.au)
-  for making the ACCESS-OM2 suite of models available at https://github.com/COSIMA/access-om2.
-  Model runs were undertaken with the assistance of resources from the National Computational Infrastructure (NCI),
-  which is supported by the Australian Government."
-  (c) let COSIMA know of any publications which use these models or data so they can add them to their list:
+  (a) add a project description to COSIMA's list:
+  https://docs.google.com/spreadsheets/d/18BDyZlHTSy6EOaf_5o9CwGBOu4pBj88XsS2vNW4R_2o
+  (b) consider citing Kiss et al. (2020) [http://doi.org/10.5194/gmd-13-401-2020] and papers describing relevant
+  configuration updates - see https://forum.access-hive.org.au/t/access-om2-control-experiments/258
+  (c) include an acknowledgement such as that suggested here: https://cosima.org.au/index.php/get-involved/
+  (d) let COSIMA know of any publications which use these models or data so they can add them to their list:
   https://scholar.google.com/citations?hl=en&user=inVqu_4AAAAJ
+  (e) Tell ACCESS-NRI that you are using ACCESS-NRI infrastructure: https://www.access-nri.org.au/resources/user-reporting/
 keywords:
   - JRA55
   - access-om2
@@ -23,6 +23,6 @@ realm:
 nominal_resolution: 100 km
 reference: https://doi.org/10.5194/gmd-13-401-2020
 license: CC-BY-4.0
-model: access-om2
+model: ACCESS-OM2
 version: "2.0"
 url: https://github.com/ACCESS-NRI/access-om2-configs/tree/release-1deg_jra55_ryf