utils

This module contains utility functions, mainly used for internal purposes.

Cache

_cache(network, func, params, result_keys[, ...])

Save result of func(**params) into network dicts using result_keys.

Checks

check_if_positive(parameters, parameter_names)	Check that will raise an error if parameters are negative.
check_for_valid_k_in_fast_synaptic_regime(...)	Check whether tau_m and tau_s imply fast synaptic regime.
_check_positive_params(func)	Decorator that checks that a fixed list of parameters is positive.
_check_k_in_fast_synaptic_regime(func)	Decorator checking whether func is operating in fast synaptic regime.

Unit and Pint Related Functions

pint_append(array, quantity[, axis])	Append quantity to np.array quantity.
pint_array(quantity_list)	Create quantity with magnitude np.array.
pint_array_of_dimension_plus_one(quantity)	Create quantity with magnitude np.array with one more dimension
_strip_units(dict)	Strip units of quantities.
_to_si_units(dict)	Convert dict of quantities to si units.
_convert_to_si_and_strip_units(dict)	Converts dict of quantities to si units and strips them.
_convert_from_si_to_prefixed(magnitude, unit)	Converts a SI magnitude to the given unit.
_convert_from_prefixed_to_si(magnitude, unit)	Converts a given unit magnitude to the corresponding SI unit magnitude.

Miscellaneous

build_full_arg_list(signature, args, kwargs)	Creates a full list of arguments including standard arguments.
get_list_of_required_parameters(func)	Returns list of arguments required by func.
get_list_of_optional_parameters(func)	Returns list of optional arguments of func.
get_required_network_params(network, func[, ...])	Extracts dict with required args for func from network.network_params.
get_optional_network_params(network, func)	Extracts dict with optional args for func from network.network_params.
get_required_results(network, keys, results_keys)	Extracts dict with results from network.results.