:py:mod:`aiida_vasp.common`
===========================

.. py:module:: aiida_vasp.common

.. autodoc2-docstring:: aiida_vasp.common
   :allowtitles:

Submodules
----------

.. toctree::
   :titlesonly:
   :maxdepth: 1

   aiida_vasp.common.dryrun
   aiida_vasp.common.sumo_kpath
   aiida_vasp.common.builder_updater
   aiida_vasp.common.transform
   aiida_vasp.common.magmapping

Package Contents
----------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`aiida_to_python <aiida_vasp.common.aiida_to_python>`
     - .. autodoc2-docstring:: aiida_vasp.common.aiida_to_python
          :summary:
   * - :py:obj:`plain_python_args <aiida_vasp.common.plain_python_args>`
     - .. autodoc2-docstring:: aiida_vasp.common.plain_python_args
          :summary:
   * - :py:obj:`parameters_validator <aiida_vasp.common.parameters_validator>`
     - .. autodoc2-docstring:: aiida_vasp.common.parameters_validator
          :summary:
   * - :py:obj:`warn_deprecated_options <aiida_vasp.common.warn_deprecated_options>`
     - .. autodoc2-docstring:: aiida_vasp.common.warn_deprecated_options
          :summary:
   * - :py:obj:`site_magnetization_to_magmom <aiida_vasp.common.site_magnetization_to_magmom>`
     - .. autodoc2-docstring:: aiida_vasp.common.site_magnetization_to_magmom
          :summary:
   * - :py:obj:`nested_update <aiida_vasp.common.nested_update>`
     - .. autodoc2-docstring:: aiida_vasp.common.nested_update
          :summary:
   * - :py:obj:`nested_update_dict_node <aiida_vasp.common.nested_update_dict_node>`
     - .. autodoc2-docstring:: aiida_vasp.common.nested_update_dict_node
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`OVERRIDE_NAMESPACE <aiida_vasp.common.OVERRIDE_NAMESPACE>`
     - .. autodoc2-docstring:: aiida_vasp.common.OVERRIDE_NAMESPACE
          :summary:

API
~~~

.. py:data:: OVERRIDE_NAMESPACE
   :canonical: aiida_vasp.common.OVERRIDE_NAMESPACE
   :value: 'incar'

   .. autodoc2-docstring:: aiida_vasp.common.OVERRIDE_NAMESPACE

.. py:function:: aiida_to_python(entity: typing.Any) -> typing.Any
   :canonical: aiida_vasp.common.aiida_to_python

   .. autodoc2-docstring:: aiida_vasp.common.aiida_to_python

.. py:function:: plain_python_args(func: typing.Callable[..., typing.Any]) -> typing.Callable[..., typing.Any]
   :canonical: aiida_vasp.common.plain_python_args

   .. autodoc2-docstring:: aiida_vasp.common.plain_python_args

.. py:function:: parameters_validator(node: aiida.orm.Dict | None, port: typing.Any = None) -> None
   :canonical: aiida_vasp.common.parameters_validator

   .. autodoc2-docstring:: aiida_vasp.common.parameters_validator

.. py:function:: warn_deprecated_options(node: aiida.orm.Dict | None, port: typing.Any = None) -> None
   :canonical: aiida_vasp.common.warn_deprecated_options

   .. autodoc2-docstring:: aiida_vasp.common.warn_deprecated_options

.. py:function:: site_magnetization_to_magmom(site_dict: dict[str, typing.Any]) -> list[float]
   :canonical: aiida_vasp.common.site_magnetization_to_magmom

   .. autodoc2-docstring:: aiida_vasp.common.site_magnetization_to_magmom

.. py:function:: nested_update(dict_in: dict[str, typing.Any], update_dict: dict[str, typing.Any], extend_list: bool = False) -> dict[str, typing.Any]
   :canonical: aiida_vasp.common.nested_update

   .. autodoc2-docstring:: aiida_vasp.common.nested_update

.. py:function:: nested_update_dict_node(dict_node: aiida.orm.Dict, update_dict: dict[str, typing.Any], extend_list: bool = False) -> aiida.orm.Dict
   :canonical: aiida_vasp.common.nested_update_dict_node

   .. autodoc2-docstring:: aiida_vasp.common.nested_update_dict_node