:py:mod:`aiida_vasp.utils.aiida_utils`
======================================

.. py:module:: aiida_vasp.utils.aiida_utils

.. autodoc2-docstring:: aiida_vasp.utils.aiida_utils
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

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

   * - :py:obj:`querybuild <aiida_vasp.utils.aiida_utils.querybuild>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.querybuild
          :summary:
   * - :py:obj:`get_data_class <aiida_vasp.utils.aiida_utils.get_data_class>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.get_data_class
          :summary:
   * - :py:obj:`get_current_user <aiida_vasp.utils.aiida_utils.get_current_user>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.get_current_user
          :summary:
   * - :py:obj:`copy_parameter <aiida_vasp.utils.aiida_utils.copy_parameter>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.copy_parameter
          :summary:
   * - :py:obj:`displaced_structure <aiida_vasp.utils.aiida_utils.displaced_structure>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.displaced_structure
          :summary:
   * - :py:obj:`compressed_structure <aiida_vasp.utils.aiida_utils.compressed_structure>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.compressed_structure
          :summary:
   * - :py:obj:`displace_position <aiida_vasp.utils.aiida_utils.displace_position>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.displace_position
          :summary:
   * - :py:obj:`compress_cell <aiida_vasp.utils.aiida_utils.compress_cell>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.compress_cell
          :summary:
   * - :py:obj:`aiida_version <aiida_vasp.utils.aiida_utils.aiida_version>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.aiida_version
          :summary:
   * - :py:obj:`cmp_version <aiida_vasp.utils.aiida_utils.cmp_version>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_version
          :summary:
   * - :py:obj:`cmp_load_verdi_data <aiida_vasp.utils.aiida_utils.cmp_load_verdi_data>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_load_verdi_data
          :summary:
   * - :py:obj:`create_authinfo <aiida_vasp.utils.aiida_utils.create_authinfo>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.create_authinfo
          :summary:
   * - :py:obj:`cmp_get_authinfo <aiida_vasp.utils.aiida_utils.cmp_get_authinfo>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_get_authinfo
          :summary:
   * - :py:obj:`cmp_get_transport <aiida_vasp.utils.aiida_utils.cmp_get_transport>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_get_transport
          :summary:
   * - :py:obj:`ensure_node_first_arg <aiida_vasp.utils.aiida_utils.ensure_node_first_arg>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.ensure_node_first_arg
          :summary:
   * - :py:obj:`ensure_node_kwargs <aiida_vasp.utils.aiida_utils.ensure_node_kwargs>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.ensure_node_kwargs
          :summary:
   * - :py:obj:`convert_dict_case <aiida_vasp.utils.aiida_utils.convert_dict_case>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.convert_dict_case
          :summary:

Data
~~~~

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

   * - :py:obj:`BASIC_DATA_TYPES <aiida_vasp.utils.aiida_utils.BASIC_DATA_TYPES>`
     - .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.BASIC_DATA_TYPES
          :summary:

API
~~~

.. py:data:: BASIC_DATA_TYPES
   :canonical: aiida_vasp.utils.aiida_utils.BASIC_DATA_TYPES
   :type: list[str]
   :value: ['core.bool', 'core.float', 'core.int', 'core.list', 'core.str', 'core.dict']

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.BASIC_DATA_TYPES

.. py:function:: querybuild(cls: type, **kwargs: typing.Any) -> aiida.orm.QueryBuilder
   :canonical: aiida_vasp.utils.aiida_utils.querybuild

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.querybuild

.. py:function:: get_data_class(data_type: str) -> type
   :canonical: aiida_vasp.utils.aiida_utils.get_data_class

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.get_data_class

.. py:function:: get_current_user() -> aiida.orm.User
   :canonical: aiida_vasp.utils.aiida_utils.get_current_user

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.get_current_user

.. py:function:: copy_parameter(old_parameter: aiida.orm.Dict) -> aiida.orm.Dict
   :canonical: aiida_vasp.utils.aiida_utils.copy_parameter

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.copy_parameter

.. py:function:: displaced_structure(structure: aiida.orm.StructureData, displacement: numpy.ndarray, entry: int) -> aiida.orm.StructureData
   :canonical: aiida_vasp.utils.aiida_utils.displaced_structure

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.displaced_structure

.. py:function:: compressed_structure(structure: aiida.orm.StructureData, volume_change: float) -> aiida.orm.StructureData
   :canonical: aiida_vasp.utils.aiida_utils.compressed_structure

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.compressed_structure

.. py:function:: displace_position(structure: aiida.orm.StructureData, displacement: numpy.ndarray, entry: int) -> None
   :canonical: aiida_vasp.utils.aiida_utils.displace_position

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.displace_position

.. py:function:: compress_cell(structure: aiida.orm.StructureData, volume_change: float) -> None
   :canonical: aiida_vasp.utils.aiida_utils.compress_cell

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.compress_cell

.. py:function:: aiida_version() -> packaging.version.Version
   :canonical: aiida_vasp.utils.aiida_utils.aiida_version

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.aiida_version

.. py:function:: cmp_version(string: str) -> packaging.version.Version
   :canonical: aiida_vasp.utils.aiida_utils.cmp_version

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_version

.. py:function:: cmp_load_verdi_data() -> typing.Any
   :canonical: aiida_vasp.utils.aiida_utils.cmp_load_verdi_data

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_load_verdi_data

.. py:function:: create_authinfo(computer: aiida.orm.Computer, store: bool = False) -> aiida.orm.AuthInfo
   :canonical: aiida_vasp.utils.aiida_utils.create_authinfo

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.create_authinfo

.. py:function:: cmp_get_authinfo(computer: aiida.orm.Computer) -> aiida.orm.AuthInfo | None
   :canonical: aiida_vasp.utils.aiida_utils.cmp_get_authinfo

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_get_authinfo

.. py:function:: cmp_get_transport(computer: aiida.orm.Computer) -> typing.Any
   :canonical: aiida_vasp.utils.aiida_utils.cmp_get_transport

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.cmp_get_transport

.. py:function:: ensure_node_first_arg(func: typing.Callable[..., typing.Any]) -> typing.Callable[..., typing.Any]
   :canonical: aiida_vasp.utils.aiida_utils.ensure_node_first_arg

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.ensure_node_first_arg

.. py:function:: ensure_node_kwargs(func: typing.Callable[..., typing.Any]) -> typing.Callable[..., typing.Any]
   :canonical: aiida_vasp.utils.aiida_utils.ensure_node_kwargs

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.ensure_node_kwargs

.. py:function:: convert_dict_case(dict_in: dict[str, typing.Any], recursive: bool = True, warn: bool = False, lower: bool = True, raise_convert: bool = False) -> dict[str, typing.Any]
   :canonical: aiida_vasp.utils.aiida_utils.convert_dict_case

   .. autodoc2-docstring:: aiida_vasp.utils.aiida_utils.convert_dict_case