Topic 2:
Compliance Checker Topics
Design, implementation and assessment of the OceanGlider (OG) 1.0 metadata standard on the IOOS Compliance Checker and related tools. This may include general initial implementation of a compliance checker plugin. The plugin may require some initial examples for testing. Related topics include addressing current issues with the compliance checker and existing plugins. Topics may include and are not necessarily limited to adding and improving CF standards checking and curation of example datasets for testing.
Another goal is to increase community engagement with the compliance checker and other IOOS repositories. The general task would be to form a uniform set of github documentation to guide user interatation with the IOOS repositories. Examples may be and are not limited to development of uniform set of issue templates, code of conduct, etc.
Expected Outcomes:
- Improved documentation for Compliance Checker and plugins
- Squash current issues for Compliance Checker and plugins
- Design and implementation of OG 1.0 plugin
- Ensure working pytest suites
- Form and utilize a uniform pool of example datasets
- General github documentation for facilitation of community engagement within IOOS repositories.
Skills required:
Python programming, basic understanding of NetCDF files and associated metadata standards (CF, ACDD, etc).
Difficulty:
Easy to Moderate
Relevant links:
Compliance Checkers
- https://github.com/ioos/compliance-checker
- https://github.com/ioos/compliance-checker-web
- https://github.com/ioos/cc-plugin-glider
- https://github.com/ioos/cc-plugin-ncei
- https://github.com/ioos/cc-plugin-ugrid
Metadata Standards
- Ocean Glider 1.0 User Manual Github
- Ocean Glider 1.0 User Manual Github.io
- NGDAC NetCDF File Format Version 2
- CF Metadata Conventions
- NECI NetCDF Templates
Vocabularies
- NERC
- GliderDAC Compliance Checker Plugin Authority Tables
Example Datasets
- pyoceans:pocean-core Test Data
- CF Conventions List of Examples
- NECI NetCDF Templates
- ERDDAP unit test examples
- Ocean Glider Example Files
- test.opendap.org
References
- OG Format User Manual Discussion #165
- OG Format User Manual Discussion #92
- OG Format User Manual PR #172
Work Completed
An Ocean Glider 1.0 plugin is largely operational with three specification tests. These tests can be combined with CF-1.8 at present with CF-1.9 and CF-1.10 coming soon! The plug-in is available from this repository which will be eventually migrated into the IOOS organizational repository.
- 10 closed pull requests for cc-plugin-glider
- 11 closed pull requests for compliance-checker
Future Actions
- Activate CF-1.9 and CF-1.10 in compliance checker for use in the OG-1.0 plugin. For now the OG-1.0 plugin can utilize CF-1.8.
- Finish off CF-1.9/CF-1.10 work
- Work on CF-1.11 in coordination with UK Met effort. This will retire the UGRID plugin.
- Changes from CF-1.8 to CF-1.9
- Changes from CF-1.9 to CF-1.10
-
Changes from CF-1.9 to CF-1.11
-
Plugin for AI? Wait for further mapping and reconcilation of AI Ready specifications to current IOOS metadata template and see what needs to be done.
- Central repository for example datasets? No. The compliance checker repository will curate for convienence only pointers to examples of interest: ERDDAP, NCEI, IOOS “golden standard” and Ocean Glider repositories. Utilization of python pooch is the recommended method of access.