picometer.settings

Attributes

logger

Exceptions

SettingsError

Custom KeyError raised when there are issues with DefaultSettings

Classes

DefaultSettings

Store default values of all settings. Use AnyValue if no default.

Settings

Automatically set self from DefaultSettings on init, handle settings

Module Contents

picometer.settings.logger
exception picometer.settings.SettingsError[source]

Bases: KeyError

Custom KeyError raised when there are issues with DefaultSettings

class picometer.settings.DefaultSettings[source]

Store default values of all settings. Use AnyValue if no default.

auto_write_unit_cell: bool = True
clear_selection_after_use: bool = True
displacement_get_cartesian_eigenvalues: bool = False
complete_uiso_from_umatrix: bool = False
complete_umatrix_from_uiso: bool = False
classmethod get_field(key: str) dataclasses.Field[source]
class picometer.settings.Settings(data: dict = None)[source]

Bases: collections.UserDict

Automatically set self from DefaultSettings on init, handle settings

classmethod from_yaml(path=None) Settings[source]
__setitem__(key, value, /) None[source]
__delitem__(key, /) None[source]
update(other: dict | collections.UserDict = None, /, **kwargs) None[source]

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