watts.Parameters#
- class watts.Parameters(*args, **kwargs)[source]#
User parameters used to generate inputs that are created by plugins
This class behaves like a normal Python dictionary except that it stores metadata on (key, value) pairs and provides the ability to save/load the data to a pickle file.
Methods
convert_units
([system, temperature, inplace])Perform unit conversion
from_pickle
(filename_or_obj)Return parameters from a pickle file
get_metadata
(key)Get metadata associated with a key
load
(filename_or_obj)Load parameters from a pickle file
save
(filename_or_obj)Save parameters to a pickle file
set
(key, value, *[, user, time])Explicitly set a key/value pair with metadata
show_summary
([show_metadata, sort_by, filter_by])Display a summary of the parameters