cf.Field.cfa_update_file_substitutions

Field.cfa_update_file_substitutions(substitutions, constructs=True)

Set CFA-netCDF file name substitutions.

New in version 3.15.0.

Parameters

substitutions: dict

The substitution definitions in a dictionary whose key/value pairs are the file name parts to be substituted and their corresponding substitution text.

Each substitution definition may be specified with or without the ${...} syntax. For instance, the following are equivalent: {'base': 'sub'}, {'${base}': 'sub'}.

constructs: bool, optional

If True (the default) then metadata constructs also have the file substitutions set on them.

Returns

None

Examples

>>> f.cfa_update_file_substitutions({'base': '/data/model'})