Instructions

tests/compval

@@ -17,8 +17,14 @@ def main(json_path=None, cv_dir_path=None):
     ''' This test validates catalogs against CMIP6 or GFDL controlled vocabulary (CV) as provided by particular JSON schemas per vocabulary type. CMIP6 CV's are found in the WCRP-CMIP/CMIP6_CVs github repository. GFDL CV's are found in the NOAA-GFDL/CMIP6_CVs github repository.
 
      JSON_PATH = Path to generated catalog JSON schema
-     CV_DIR_PATH = Path to CMIP6 CV Repository. '''
+     CV_DIR_PATH = Path to CMIP6 CV Repository.
 
+     USAGE:
+         To validate against GFDL CV's: compval <json_path>
+         (Uses CV found in json's "vocabulary" field)
+
+         To validate against CMIP CV's: compval <json_path> <cv_dir_path>
+         (Must clone WCRP-CMIP/CMIP6_CVs github directory. CV is found automatically given the path to this directory) '''
     bad_vocab = []
     nan_list = []
     vocab_list = []