Clean up initial ACDD rules

Adds documentation for ACDD tests, isodate to the dependencies, and updates the changes.

Author: abkfenris

CHANGES.md

@@ -1,5 +1,15 @@
 # XRLint Change History
 
+## Upcoming
+
+- Implements an initial set of [Attribute Conventions Data Discovery (ACCD)](https://wiki.esipfed.org/Category:Attribute_Conventions_Dataset_Discovery) rules adapted from the [IOOS Compliance Checker](https://github.com/ioos/compliance-checker/) library.
+  - Configs for ACDD 1.0, 1.1, and 1.3, and with selectable levels of severity. The reccomended set uses ACDD 1.3 with the highly recomended rules as errors.
+  - Global attribute existance rules.
+  - Checks that ACDD is in the conventions attribute.
+  - Makes sure the date attributes are ISO formatted.
+  - Metadata links are URLs.
+  - The ID attribute should not be blank.
+
 ## Version 0.5.1 (from 2025-02-21)
 
 - XRLint now also loads default configuration from files named 

docs/rule-ref.md

@@ -199,3 +199,75 @@ Time coordinate and dimension should be called 'time'.
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 
+## ACDD Rules
+
+### :material-bug: `1.0-attrs-highly-recommended`
+
+Global attributes that are highly reccomended by ACDD-1.0.
+[More...](https://wiki.esipfed.org/Category:Attribute_Conventions_Dataset_Discovery)
+
+Contained in:  `acdd_1.0`-:material-lightning-bolt:
+
+### :material-bug: `1.0-attrs-recommended`
+
+Global attributes that are recommended by ACDD-1.0.
+[More...](https://wiki.esipfed.org/Category:Attribute_Conventions_Dataset_Discovery)
+
+Contained in:  `acdd_1.0`-:material-alert:
+
+### :material-bug: `1.0-attrs-suggested`
+
+Global attributes that are suggested by ACDD-1.0.
+[More...](https://wiki.esipfed.org/Category:Attribute_Conventions_Dataset_Discovery)
+
+Contained in:  `acdd_1.0`-:material-alert:
+
+### :material-bug: `1.3-attrs-highly-recommended`
+
+Global attributes that are highly recommended by ACDD-1.3.
+[More...](https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3)
+
+Contained in:  `acdd_1.3`-:material-lightning-bolt: `acdd_1.3_strict`-:material-lightning-bolt: `acdd_1.3_strict_reccomended`-:material-lightning-bolt: `acdd_1.3_warn`-:material-alert: `recommended`-:material-lightning-bolt:
+
+### :material-bug: `1.3-attrs-recommended`
+
+Global attributes that are recommended by ACDD-1.3.
+[More...](https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3)
+
+Contained in:  `acdd_1.3`-:material-alert: `acdd_1.3_strict`-:material-lightning-bolt: `acdd_1.3_strict_reccomended`-:material-lightning-bolt: `acdd_1.3_warn`-:material-alert: `recommended`-:material-alert:
+
+### :material-bug: `1.3-attrs-suggested`
+
+Global attributes that are suggested by ACDD 1.3.
+[More...](https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3)
+
+Contained in:  `acdd_1.3`-:material-alert: `acdd_1.3_strict`-:material-lightning-bolt: `acdd_1.3_strict_reccomended`-:material-alert: `acdd_1.3_warn`-:material-alert: `recommended`-:material-alert:
+
+### :material-bug: `1.3-conventions`
+
+The `Conventions` global attribute should include `ACDD-1.3`.
+[More...](https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3)
+
+Contained in:  `acdd_1.3`-:material-lightning-bolt: `acdd_1.3_strict`-:material-lightning-bolt: `acdd_1.3_strict_reccomended`-:material-lightning-bolt: `acdd_1.3_warn`-:material-alert: `recommended`-:material-lightning-bolt:
+
+### :material-bug: `1.3-dates-iso-format`
+
+ACDD date attributes must be in ISO format.
+[More...](https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3)
+
+Contained in:  `acdd_1.3`-:material-alert: `acdd_1.3_strict`-:material-lightning-bolt: `acdd_1.3_strict_reccomended`-:material-alert: `acdd_1.3_warn`-:material-alert: `recommended`-:material-alert:
+
+### :material-bug: `1.3-metadata-link`
+
+The `metadata` attribute should be a URL.
+[More...](https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3)
+
+Contained in:  `acdd_1.3`-:material-alert: `acdd_1.3_strict`-:material-lightning-bolt: `acdd_1.3_strict_reccomended`-:material-alert: `acdd_1.3_warn`-:material-alert: `recommended`-:material-alert:
+
+### :material-bug: `1.3-no-blanks-in-id`
+
+The `id` attribute should not contain blanks.
+[More...](https://wiki.esipfed.org/Attribute_Convention_for_Data_Discovery_1-3)
+
+Contained in:  `acdd_1.3`-:material-alert: `acdd_1.3_strict`-:material-lightning-bolt: `acdd_1.3_strict_reccomended`-:material-alert: `acdd_1.3_warn`-:material-alert: `recommended`-:material-alert:
+

mkruleref.py

@@ -27,9 +27,11 @@
 def write_rule_ref_page():
     import xrlint.plugins.core
     import xrlint.plugins.xcube
+    import xrlint.plugins.acdd
 
     core = xrlint.plugins.core.export_plugin()
     xcube = xrlint.plugins.xcube.export_plugin()
+    acdd = xrlint.plugins.acdd.export_plugin()
     with open("docs/rule-ref.md", "w") as stream:
         stream.write("# Rule Reference\n\n")
         stream.write(
@@ -41,6 +43,8 @@ def write_rule_ref_page():
         write_plugin_rules(stream, core)
         stream.write("## xcube Rules\n\n")
         write_plugin_rules(stream, xcube)
+        stream.write("## ACDD Rules\n\n")
+        write_plugin_rules(stream, acdd)
 
 
 def write_plugin_rules(stream, plugin: Plugin):

pyproject.toml

@@ -6,7 +6,8 @@ build-backend = "setuptools.build_meta"
 name = "xrlint"
 dynamic = ["version", "readme"]
 authors = [
-  {name = "Norman Fomferra (Brockmann Consult GmbH)"}
+  {name = "Norman Fomferra (Brockmann Consult GmbH)"},
+  {name = "Alex Kerney (GMRI / NERACOOS)", email = "akerney@gmri.org"}
 ]
 description = "A linter for xarray datasets."
 keywords = [
@@ -17,6 +18,7 @@ requires-python = ">=3.10"
 dependencies = [
   "click",
   "fsspec",
+  "isodate>=0.7.2",
   "pyyaml",
   "tabulate",
   "xarray",
@@ -63,11 +65,6 @@ exclude = ["**/*.ipynb"]
 [project.scripts]
 xrlint = "xrlint.cli.main:main"
 
-[project.optional-dependencies]
-acdd = [
-    "isodate>=0.7.2",
-]
-
 [dependency-groups]
 dev = [
   # Development tools

tests/plugins/acdd/rules/test_attributes.py

@@ -10,14 +10,14 @@
         "title": "Tis only a test",
         "summary": "This is only a test dataset.",
         "keywords": "test, example, sample",
-        "conventions": "ACDD-1.3",
+        "Conventions": "ACDD-1.3",
     },
 )
 invalid_1_3_highly_rec_dataset = xr.Dataset()
 
 
 Attributes_1_3_Highly_ReccomendedTest = RuleTester.define_test(
-    "1.3_attrs_highly_recommended",
+    "1.3-attrs-highly-recommended",
     Attributes_1_3_Highly_Reccomended,
     valid=[RuleTest(dataset=valid_1_3_highly_rec_dataset)],
     invalid=[
@@ -27,7 +27,7 @@
                 "Missing highly recommended attribute 'title'",
                 "Missing highly recommended attribute 'keywords'",
                 "Missing highly recommended attribute 'summary'",
-                "Missing highly recommended attribute 'conventions'",
+                "Missing highly recommended attribute 'Conventions'",
             ],
         ),
     ],

tests/plugins/acdd/rules/test_conventions.py

@@ -11,7 +11,7 @@
 
 
 ConventionsTest = RuleTester.define_test(
-    "1.3_conventions",
+    "1.3-conventions",
     Conventions,
     valid=[
         RuleTest(dataset=valid_dataset_0),

tests/plugins/acdd/rules/test_id_blanks.py

@@ -3,14 +3,14 @@
 
 from xrlint.plugins.acdd.rules.no_id_blanks import NoBlanksInID
 
-valid_dataset_0 = xr.Dataset(attrs={"id": "testind_dataset"})
+valid_dataset_0 = xr.Dataset(attrs={"id": "testing_dataset"})
 
 invalid_dataset_0 = xr.Dataset()
 invalid_dataset_1 = xr.Dataset(attrs={"id": "testing dataset"})
 
 
 IdBlanksTest = RuleTester.define_test(
-    "1.3_no_blanks_in_id",
+    "1.3-no-blanks-in-id",
     NoBlanksInID,
     valid=[RuleTest(dataset=valid_dataset_0)],
     invalid=[
@@ -20,7 +20,7 @@
         ),
         RuleTest(
             dataset=invalid_dataset_1,
-            expected=["There should be no blanks in the id field"],
+            expected=["There should not be blanks in the id field"],
         ),
     ],
 )

tests/plugins/acdd/rules/test_iso_dates.py

@@ -21,7 +21,7 @@
 )  # Invalid hour
 
 IsoDatesTest = RuleTester.define_test(
-    "1.3_dates_iso_format",
+    "1.3-dates-iso-format",
     IsoDates,
     valid=[
         RuleTest(dataset=valid_dataset_0),

tests/plugins/acdd/rules/test_metadata_link.py

@@ -10,7 +10,7 @@
 invalid_dataset_0 = xr.Dataset(attrs={"metadata_link": "example.com/metadata"})
 
 Metadata_LinkTest = RuleTester.define_test(
-    "1.3_metadata_link",
+    "1.3-metadata-link",
     MetadataLink,
     valid=[
         RuleTest(dataset=valid_dataset_0),

tests/plugins/acdd/test_plugin.py

@@ -8,16 +8,16 @@ def test_rules_complete(self):
         plugin = export_plugin()
         self.assertEqual(
             {
-                "1.3_conventions",
-                "1.0_attrs_suggested",
-                "1.0_attrs_highly_recommended",
-                "1.0_attrs_recommended",
-                "1.3_attrs_recommended",
-                "1.3_attrs_suggested",
-                "1.3_attrs_highly_recommended",
-                "1.3_no_blanks_in_id",
-                "1.3_metadata_link",
-                "1.3_dates_iso_format",
+                "1.3-conventions",
+                "1.0-attrs-suggested",
+                "1.0-attrs-highly-recommended",
+                "1.0-attrs-recommended",
+                "1.3-attrs-recommended",
+                "1.3-attrs-suggested",
+                "1.3-attrs-highly-recommended",
+                "1.3-no-blanks-in-id",
+                "1.3-metadata-link",
+                "1.3-dates-iso-format",
             },
             set(plugin.rules.keys()),
         )