Metadata

Extra CF-convention attributes merged into the output variables at finalisation. Supports the same keys as attributes.yml: coords, data_vars, stats, stat_units.

metadata:
  data_vars:
    hs:
      standard_name: sea_surface_wave_significant_height
      long_name: significant wave height
      units: m
  coords:
    latitude:
      standard_name: latitude
      long_name: latitude
      units: degrees_north
  stats:
    mean:
      long_name: mean
  stat_units:
    pcount: "%"

Stat units

Most statistics keep the units of the variable they are computed from — the mean of an Hs field is still in metres. Those that do not, such as pcount (a percentage) or range_probability (a dimensionless fraction), declare their own units under stat_units, which take precedence over the parent variable's:

stat_units:
  pcount: "%"
  probability: "1"
  exceedance: "1"
  nonexceedance: "1"

The key is matched against any _-separated token of the output variable name, so hs_gt_1p5_range_probability_month resolves through its probability token.

Note

metadata controls variable-level CF attributes (standard_name, long_name, units). For global dataset attributes (title, institution, etc.) use output.global_attrs instead.