xoa

xarray-based ocean analysis library

The successor of Vacumm.

Functions

get_data_sample([filename])	Get the absolute path to a sample file
get_option(section[, option])	Get a config option
load_options([cfgfile])	Load specified options
open_data_sample(filename, **kwargs)	Open a data sample with xarray.open_dataset() or pandas.read_csv()
register_accessors([xoa, xcf, decode_sigma])	Register xarray accessors
reset_options()	Restore options to their default values in the current session
set_option(option, value)	Set a single option using the flat format, i.e section.option
show_data_samples([full_paths])	Print the list of data samples
show_info([opt_specs])	Print xoa related info
show_options([specs])	Print current xoa configuration
show_paths()	Print some xoa paths
show_versions()	Print the versions of xoa and of some dependencies
xoa_warn(message[, stacklevel])	Issue a XoaWarning warning

Classes

set_options([section])

Set configuration options

Exceptions

XoaConfigError
XoaError
XoaWarning