This plugin is meant to check the global attributes of netCDF files for the conformance with the CMIP6 standard. The global attributes are checked against controlled vocabularies (CVs). Other things like the coordinates system within the netCDF files, the CF Conventions or the DRS are not checked. Compliance with the CF Conventions has to be checked with the CF Conventions Plugin.

If you deploy this Plugin in a multi-user environment (e.g. a HPC system) you might consider to place the CVs at a central location and let the user's environement variable CMIP6_JSON_PATH point to the location. See further below for details.

This Plugin is made in a way that several functions can be reused when things (texts, global attributes, variable names, ...) should be checked against other controlled vocabularies. There is a structure __cmip6_cv_struct_dict__ defined in cv_tools from which an instance of cv_structure is generated. The resulting object holds information on how the things are compared against the CVs.

Useful links:

• This plugin's repository: https://github.com/neumannd/cc-plugin-cmip6-cv
• IOOS Compliance Checker repository: https://github.com/ioos/compliance-checker
• CMIP6 CV repository: https://github.com/WCRP-CMIP/CMIP6_CVs

First install the IOOS Compliance Checker -- e.g. via Conda:

conda install -c conda-forge compliance-checker

For details please read the IOOS Compliance Checker Installtion Note.

not available yet; later it will be:

# NOT WORKING YET
conda install -c conda-forge cc-plugin-cmip6-cv

not available yet

python setup.py install

Uninstall before new install:

pip uninstall cc-plugin-cmip6-cv

$ compliance-checker -l
IOOS compliance checker available checker suites (code version):
  ...
  - cmip6_cv (x.x.x)
  ...
$ compliance-checker -t cmip6_cv [dataset_location]

See the ioos/compliance-checker for additional Usage notes

...

Failures in these checks should be addressed before submitting within AtMoDat!

• check_cvs

• currently none

• currently none

The path of existing CMIP6 JSON controlled vocabulary (CV) files can be provided explicitly via:

• CMIP6_JSON_PATH

Please see the notes below

tldr;: Please look into the table below for a quick overview over where CVs are expected and when/if they are updated.

Controlled vocabularies (CV) are imported from the official CMIP6 CV files. These are JSON files.

This plugin contains its own set of CMIP6 CV files. They might be outdated in future. By default, the plugin looks in into the user's home folder for CV files. If they exist, the plugin tries to update them if the last update was performed more than 7 days ago (cc_plugin_cmip6_cv.util.__update_period__).

Note: cc_plugin_cmip6_cv.CMIP6BaseCheck.__cc_spec does probably have the value cmip6. However, this might change.

Some CVs are provided as dictionaries. Some global attributes are compared against the keys of these dictionaries and others are compared agains the values of these dictionaries. The instance of the class cv_structure contains information what should be done. We did define this in a general sense: the user provides a function name; this name is looked up in a list of allowed functions; a function returns a callable corresponding to the provided name; this is hard-coded to prevent code injection; the returned callable is called with associated CV as input.

To generate a proper instance of cv_structure for the current CMIP6 CVs one should instanciate it with cc_plugin_cmip6_cv.cv_tools.__cmip6_cv_struct_dict__. This variable is also a good example on how to adapt this plugin for checking other CVs.

TODO

• user sacuL in post https://stackoverflow.com/a/53527901/4612235
• use jfs in post https://stackoverflow.com/a/15300191/4612235
• https://stackoverflow.com/a/53527901/4612235
• general on decorators:
  • https://stackoverflow.com/questions/15299878/how-to-use-python-decorators-to-check-function-arguments
  • https://realpython.com/primer-on-python-decorators/
  • https://wiki.python.org/moin/PythonDecorators
  • https://dev.to/apcelent/python-decorator-tutorial-with-example-529f
• processing of **kwargs:
  • http://www.informit.com/articles/article.aspx?p=2314818
  • https://stackoverflow.com/questions/53128068/keyerror-in-python-kwargs
• get name of current function
  • https://www.oreilly.com/library/view/python-cookbook/0596001673/ch14s08.html
  • https://stackoverflow.com/q/5067604/4612235
  • sys._getframe().f_code.co_name
• extract n'th element of dict
  • https://stackoverflow.com/questions/16977385/extract-the-nth-key-in-a-python-dictionary/16977485
  • https://stackoverflow.com/questions/16819222/how-to-return-dictionary-keys-as-a-list-in-python
  • or next(iter(dict.keys()))
• inspect functions signature
  • https://www.programcreek.com/python/example/81294/inspect.signature
• Test Docrators
  • https://stackoverflow.com/questions/34648337/how-to-test-a-decorator-in-a-python-package/34648674

This plugin was originally created within the AtMoDat project (Atmospheric Model Data, https://www.atmodat.de). AtMoDat is funded by the German Federal Ministry for Education and Research within the framework of Atmosphären-Modelldaten: Datenqualität, Kurationskriterien und DOI-Branding (FKZ 16QK02A).