watts.Parameters

class watts.Parameters(*args, **kwargs)

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 an HDF5 file.

warn_duplicates

Whether to write a warning if a key is added and already exists

Type

bool

Methods

convert_units([system, temperature, inplace])	Perform unit conversion
from_hdf5(filename_or_obj)	Return parameters from HDF5 file/group
get_metadata(key)	Get metadata associated with a key
load(filename_or_obj)	Load parameters from an HDF5 file
save(filename_or_obj)	Save parameters to an HDF5 file/group
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

previous

watts.Database.show_summary

next

watts.Parameters.convert_units