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

.. py:module:: aiida_vasp.commands.utils

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`load_structure <aiida_vasp.commands.utils.load_structure>`
     - .. autodoc2-docstring:: aiida_vasp.commands.utils.load_structure
          :summary:
   * - :py:obj:`setup_calculation_options <aiida_vasp.commands.utils.setup_calculation_options>`
     - .. autodoc2-docstring:: aiida_vasp.commands.utils.setup_calculation_options
          :summary:
   * - :py:obj:`apply_additional_updates <aiida_vasp.commands.utils.apply_additional_updates>`
     - .. autodoc2-docstring:: aiida_vasp.commands.utils.apply_additional_updates
          :summary:
   * - :py:obj:`handle_calculation_submission <aiida_vasp.commands.utils.handle_calculation_submission>`
     - .. autodoc2-docstring:: aiida_vasp.commands.utils.handle_calculation_submission
          :summary:

API
~~~

.. py:function:: load_structure(structure_path: str | pathlib.Path) -> aiida.orm.StructureData
   :canonical: aiida_vasp.commands.utils.load_structure

   .. autodoc2-docstring:: aiida_vasp.commands.utils.load_structure

.. py:function:: setup_calculation_options(options, resources, max_wallclock_seconds, num_machines, tot_num_mpiprocs)
   :canonical: aiida_vasp.commands.utils.setup_calculation_options

   .. autodoc2-docstring:: aiida_vasp.commands.utils.setup_calculation_options

.. py:function:: apply_additional_updates(upd: aiida_vasp.common.builder_updater.VaspBuilderUpdater, additional_overrides: dict)
   :canonical: aiida_vasp.commands.utils.apply_additional_updates

   .. autodoc2-docstring:: aiida_vasp.commands.utils.apply_additional_updates

.. py:function:: handle_calculation_submission(upd: aiida_vasp.common.builder_updater.VaspBuilderUpdater, run_directly: bool, group: str, alias: str | None = None) -> aiida.orm.ProcessNode
   :canonical: aiida_vasp.commands.utils.handle_calculation_submission

   .. autodoc2-docstring:: aiida_vasp.commands.utils.handle_calculation_submission