cavcalc.parameters.tools

Functions for retrieving information on parameters, typically provided via both str and ParameterType arguments.

Functions

get_default_units(ptype)	Get the default units, as a string, of the given parameter type.
get_name(ptype)	Obtain the name of a parameter from the ParameterType literal.
get_names(*args)	Retrieve a tuple of the names of all the parameters exposed by cavcalc, or all the parameters in the categories given in args.
get_names_descriptions()	Get a dictionary of all the parameter names with a description of each of these.
get_type(name)	Get the ParameterType literal corresponding to the given name of the parameter.
get_valid_arguments()	Get the names of all the parameters which can be used as arguments in a calculate() / CLI call.
get_valid_targets()	Get the names of all the parameters which can be specified as targets in a calculate() / CLI call.