improver.cli.interpret_metadata module

Script to interpret the metadata of an IMPROVER output.

process(*file_paths, verbose=False, failures_only=False)[source]

Intepret the metadata of an IMPROVER output into human readable format according to the IMPROVER standard. An optional verbosity flag, if set to True, will specify the source of each interpreted element.

This tool is intended as an aid to developers in adding and modifying metadata within the code base.

Parameters:

  • file_paths (list of Path objects) – File paths to netCDF files for which the metadata should be interpreted.

  • verbose (bool) – Boolean flag to output information about sources of metadata interpretation.

  • failures_only (bool) – Boolean flag that, if set, means only information about non-compliant files is printed.

Raises:

ValueError – If any of the input files are not metadata compliant.