`xyzpy.gen.prepare`#

Module Contents#

`_str_2_tuple`(x)	Ensure x is at least a 1-tuple of str.
`dictify`(x)	Ensure x is a dict.
`parse_fn_args`(fn, fn_args)
`check_for_duplicates`(arg, values)
`parse_combos`(combos)	Turn dicts and single tuples into proper form for combo runners.
`parse_combo_results`(results, var_names)
`parse_cases`(cases[, fn_args])
`parse_case_results`(results, var_names)
`parse_var_names`(var_names)
`parse_var_dims`(var_dims, var_names)	Parse function mapping parameters into standard form.

xyzpy.gen.prepare._str_2_tuple(x)[source]#: Ensure x is at least a 1-tuple of str.

xyzpy.gen.prepare.parse_combos(combos)[source]#: Turn dicts and single tuples into proper form for combo runners.

xyzpy.gen.prepare.parse_var_dims(var_dims, var_names)[source]#

Parse function mapping parameters into standard form.

Parameters:

var_dims (dict, tuple, or str) –
- dict
  Mapping of each output to its dimensions, each either str or tuple of str. The keys themselves can be a tuple of several output names if they all have the same dimensions.
- tuple
  List of output dimensions directly corresponding to list of var_names. Must be same length as var_names
- str
  Only allowed for single output with single dimension.
var_names (tuple of str, str, or None) –
- tuple of str
  List of names of var_names.
- str
  Single named output.
- None
  Automatic result output using Dataset/DataArray, in this case check that var_dims is None as well.