perturbopy.postproc.dbs.units_dict.UnitsDict

class perturbopy.postproc.dbs.units_dict.UnitsDict(units, *args, **kwargs)

Bases: dict

Modified dictionary class to store physical quantities with units. Class representation of a set of physical quantities with units organized in a dictionary. The physical quantities may either be arrays or floats.

data

TODO: UnitsDict DOES NOT HAVE A data ATTRIBUTE Dictionary of floats or array_like types of physical quantities

Type:: dict

units

The units of the physical quantities

Type:: str {}

Methods

`clear`	D.clear() -> None.
`copy`	D.copy() -> a shallow copy of D
`from_dict`	Class method to create a UnitsDict object from a Python dictionary and a set of units.
`fromkeys`	Create a new dictionary with keys from iterable and values set to value.
`get`	Return the value for key if key is in the dictionary, else default.
`items`	D.items() -> a set-like object providing a view on D's items
`keys`	D.keys() -> a set-like object providing a view on D's keys
`pop`	D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
`popitem`	Remove and return a (key, value) pair as a 2-tuple.
`setdefault`	Insert key with a value of default if key is not in the dictionary.
`update`	D.update([E, ]**F) -> None.
`values`	D.values() -> an object providing a view on D's values

clear() → None. Remove all items from D.

copy() → a shallow copy of D

classmethod from_dict(input_dict, units): Class method to create a UnitsDict object from a Python dictionary and a set of units.

classmethod fromkeys(iterable, value=None, /): Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /): Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from mapping/iterable E and F.: If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values