polaris.ocean.global_stats_names.global_stats_var_names

polaris.ocean.global_stats_names.global_stats_var_names(fields, stats, model, field_map=None, time_mean_period=None)

Build the names of the global statistics variables to look for

Parameters:

• fields (list of str) – The fields whose statistics are wanted. These are the names the caller uses to label its results; field_map says what the model calls each of them.

• stats (list of str) – The statistics to look for, each of them one of available_stats() for this model

• model ({'mpas-ocean', 'omega'}) – The ocean model that wrote the output

• field_map (dict of str to str, optional) – What the model calls each field, as polaris.tasks.ocean.Ocean.map_var_list_to_native_model() gives it. A field that is missing from the map keeps its own name, which is the right answer for a field only one model has.

• time_mean_period (str, optional) – The period of the time reduction the variables were averaged over, e.g. '1Month'. The default is the spelling used for snapshots, which carry no period at all.

Returns:

var_names (dict of (str, str) to str) – The variable name of each (field, stat) pair, in the order the fields and the statistics were given

Raises:

ValueError – If a statistic is not one this model computes, or if a time mean is asked of a model that writes none