xoa.cf

Naming convention tools for reading and formatting variables

How to use it

See the Naming conventions with xoa.cf section.

Functions

are_similar(da0, da1)	Check if two DataArrays are similar
assign_cf_specs(ds[, name, register])	Set the cf_specs encoding to name in all data vars and coords
get_cf_specs([name, cache])	Get the current or a registered CF specifications instance
get_cf_specs_encoding(ds)	Get the cf_specs encoding value
get_cf_specs_from_encoding(ds)	Get a registered CF specs instance from the cf_specs encoding value
get_cf_specs_from_name(name[, errors])	Get a registered CF specs instance from its name
get_cf_specs_matching_score(ds, cfspecs)	Get the matching score between ds data_vars and coord names and a CFSpecs instance names
get_default_cf_specs([cache])	Get the default CF specifications
get_matching_item_specs(da[, loc])	Get the item CF specs that match this data array
get_registered_cf_specs([current, reverse, ...])	Get the list of registered CFSpecs
infer_cf_specs(ds[, named])	Get the registered CFSpecs that are best matching this dataset
infer_coords(ds)	Search for known coords and make sure they are set as coords
is_registered_cf_specs(name)	Check if given cf specs set is registered
register_cf_specs(*args, **kwargs)	Register CFSpecs in a bank optionally with a name
reset_cache([disk, memory])	Reset the on disk and/or in memory cf specs cache
search_similar(obj, da)	Search in ds for a similar DataArray
show_cache()	Show the cf specs cache file

Classes

CFCoordSpecs(parent)	CF specification for coords
CFSpecs([cfg, default, user, name, cache])	Manager for CF specifications
CFVarSpecs(parent)	CF specification for data_vars
SGLocator([name_format, valid_locations, ...])	Staggered grid location parsing and formatting utility
set_cf_specs(cf_source)	Set the current CF specs

Exceptions

XoaCFError