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

.. py:module:: aiida_vasp.utils.workchains

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`prepare_process_inputs <aiida_vasp.utils.workchains.prepare_process_inputs>`
     - .. autodoc2-docstring:: aiida_vasp.utils.workchains.prepare_process_inputs
          :summary:
   * - :py:obj:`compare_structures <aiida_vasp.utils.workchains.compare_structures>`
     - .. autodoc2-docstring:: aiida_vasp.utils.workchains.compare_structures
          :summary:
   * - :py:obj:`fetch_k_grid <aiida_vasp.utils.workchains.fetch_k_grid>`
     - .. autodoc2-docstring:: aiida_vasp.utils.workchains.fetch_k_grid
          :summary:
   * - :py:obj:`compose_exit_code <aiida_vasp.utils.workchains.compose_exit_code>`
     - .. autodoc2-docstring:: aiida_vasp.utils.workchains.compose_exit_code
          :summary:
   * - :py:obj:`site_magnetization_to_magmom <aiida_vasp.utils.workchains.site_magnetization_to_magmom>`
     - .. autodoc2-docstring:: aiida_vasp.utils.workchains.site_magnetization_to_magmom
          :summary:

API
~~~

.. py:function:: prepare_process_inputs(inputs: typing.Any, namespaces: typing.Optional[typing.List[str]] = None, exclude_parameters: typing.Optional[typing.List[str]] = None) -> aiida.common.extendeddicts.AttributeDict
   :canonical: aiida_vasp.utils.workchains.prepare_process_inputs

   .. autodoc2-docstring:: aiida_vasp.utils.workchains.prepare_process_inputs

.. py:function:: compare_structures(structure_a: typing.Any, structure_b: typing.Any) -> aiida.common.extendeddicts.AttributeDict
   :canonical: aiida_vasp.utils.workchains.compare_structures

   .. autodoc2-docstring:: aiida_vasp.utils.workchains.compare_structures

.. py:function:: fetch_k_grid(rec_cell: typing.Any, k_spacing: typing.Any) -> typing.List[int]
   :canonical: aiida_vasp.utils.workchains.fetch_k_grid

   .. autodoc2-docstring:: aiida_vasp.utils.workchains.fetch_k_grid

.. py:function:: compose_exit_code(status: int, message: str) -> aiida.engine.processes.exit_code.ExitCode
   :canonical: aiida_vasp.utils.workchains.compose_exit_code

   .. autodoc2-docstring:: aiida_vasp.utils.workchains.compose_exit_code

.. py:function:: site_magnetization_to_magmom(site_dict: typing.Any) -> typing.List[typing.Any]
   :canonical: aiida_vasp.utils.workchains.site_magnetization_to_magmom

   .. autodoc2-docstring:: aiida_vasp.utils.workchains.site_magnetization_to_magmom