`aiida_vasp.common`#

Common functions and constants

Submodules#

Package Contents#

Functions#

`aiida_to_python`	Convert AiiDA entity to plain python objects
`plain_python_args`	Ensure that the first argument is a plain dictionary
`parameters_validator`	Validate the parameters input by passing it through the massager
`warn_deprecated_options`	Validate the parameters input by passing it through the massager
`site_magnetization_to_magmom`	Convert site mangetization to MAGMOM used for restart NOTE: to be replaced by stock function in aiida_vasp.utils.workchains
`nested_update`	Update the dictionary - combine nested sub-dictionary with update as well
`nested_update_dict_node`	Utility to update a Dict node in a nested way

Data#

OVERRIDE_NAMESPACE

API#

aiida_vasp.common.OVERRIDE_NAMESPACE = 'incar'#

aiida_vasp.common.aiida_to_python(entity: Any) → Any[source]#: Convert AiiDA entity to plain python objects

aiida_vasp.common.plain_python_args(func: Callable[..., Any]) → Callable[..., Any][source]#: Ensure that the first argument is a plain dictionary

aiida_vasp.common.parameters_validator(node: aiida.orm.Dict | None, port: Any = None) → None[source]#: Validate the parameters input by passing it through the massager

aiida_vasp.common.warn_deprecated_options(node: aiida.orm.Dict | None, port: Any = None) → None[source]#: Validate the parameters input by passing it through the massager

aiida_vasp.common.site_magnetization_to_magmom(site_dict: dict[str, Any]) → list[float][source]#: Convert site mangetization to MAGMOM used for restart NOTE: to be replaced by stock function in aiida_vasp.utils.workchains

aiida_vasp.common.nested_update(dict_in: dict[str, Any], update_dict: dict[str, Any], extend_list: bool = False) → dict[str, Any][source]#: Update the dictionary - combine nested sub-dictionary with update as well

aiida_vasp.common.nested_update_dict_node(dict_node: aiida.orm.Dict, update_dict: dict[str, Any], extend_list: bool = False) → aiida.orm.Dict[source]#: Utility to update a Dict node in a nested way