cf.load_stash2standard_nameΒΆ

cf.load_stash2standard_name(table=None, delimiter='!', merge=True)[source]ΒΆ

Load a STASH to standard name conversion table.

This used when reading PP and UM fields files.

Parameters:
table: str, optional

Use the conversion table at this file location. By default the table will be looked for at os.path.join(os.path.dirname(cf.__file__),'etc/STASH_to_CF.txt')

delimiter: str, optional

The delimiter of the table columns. By default, ! is taken as the delimiter.

merge: bool, optional

If table is None then merge is taken as False, regardless of its given value.

Returns:
dict

The new STASH to standard name conversion table.

Examples:

>>> cf.load_stash2standard_name()
>>> cf.load_stash2standard_name('my_table.txt')
>>> cf.load_stash2standard_name('my_table2.txt', ',')
>>> cf.load_stash2standard_name('my_table3.txt', merge=True)
>>> cf.load_stash2standard_name('my_table4.txt', merge=False)