atomli.units

Generated from the public Python surface of Atomli 0.1.4.

Units(*args, **kwargs)

Dictionary for units that supports .attribute access.

clear(self, /)

Remove all items from the dict.

copy(self, /)

Return a shallow copy of the dict.

fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(self, key, default=None, /)

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

items(self, /)

Return a set-like object providing a view on the dict’s items.

keys(self, /)

Return a set-like object providing a view on the dict’s keys.

pop

D.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(self, /)

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(self, 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

D.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(self, /)

Return an object providing a view on the dict’s values.

create_units(codata_version)

Function that creates a dictionary containing all units previously hard coded in ase.units depending on a certain CODATA version. Note that returned dict has attribute access it can be used in place of the module or to update your local or global namespace.

Parameters

codata_version: str The CODATA version to be used. Implemented are

* '1986'
* '1998'
* '2002'
* '2006'
* '2010'
* '2014'
* '2018'
* '2022'

Returns

units: dict Dictionary that contains all formerly hard coded variables from ase.units as key-value pairs. The dict supports attribute access.

Raises

NotImplementedError If the required CODATA version is not known.