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

.. py:module:: aiida_vasp.utils.export

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`export_vasp <aiida_vasp.utils.export.export_vasp>`
     - .. autodoc2-docstring:: aiida_vasp.utils.export.export_vasp
          :summary:
   * - :py:obj:`_export_calculation <aiida_vasp.utils.export._export_calculation>`
     - .. autodoc2-docstring:: aiida_vasp.utils.export._export_calculation
          :summary:
   * - :py:obj:`export_pseudos <aiida_vasp.utils.export.export_pseudos>`
     - .. autodoc2-docstring:: aiida_vasp.utils.export.export_pseudos
          :summary:
   * - :py:obj:`_export_workchain <aiida_vasp.utils.export._export_workchain>`
     - .. autodoc2-docstring:: aiida_vasp.utils.export._export_workchain
          :summary:
   * - :py:obj:`export_neb <aiida_vasp.utils.export.export_neb>`
     - .. autodoc2-docstring:: aiida_vasp.utils.export.export_neb
          :summary:
   * - :py:obj:`copy_from_aiida <aiida_vasp.utils.export.copy_from_aiida>`
     - .. autodoc2-docstring:: aiida_vasp.utils.export.copy_from_aiida
          :summary:
   * - :py:obj:`save_all_repository_objects <aiida_vasp.utils.export.save_all_repository_objects>`
     - .. autodoc2-docstring:: aiida_vasp.utils.export.save_all_repository_objects
          :summary:

API
~~~

.. py:function:: export_vasp(process_node: aiida.orm.Node, dst: str | pathlib.Path, decompress: bool = False, include_potcar: bool = False) -> None
   :canonical: aiida_vasp.utils.export.export_vasp

   .. autodoc2-docstring:: aiida_vasp.utils.export.export_vasp

.. py:function:: _export_calculation(calc_node: aiida.orm.CalcJobNode, dst: pathlib.Path, decompress: bool = False, include_potcar: bool = False) -> None
   :canonical: aiida_vasp.utils.export._export_calculation

   .. autodoc2-docstring:: aiida_vasp.utils.export._export_calculation

.. py:function:: export_pseudos(calc_job_node: typing.Any, folder: pathlib.Path) -> None
   :canonical: aiida_vasp.utils.export.export_pseudos

   .. autodoc2-docstring:: aiida_vasp.utils.export.export_pseudos

.. py:function:: _export_workchain(work_node: aiida.orm.WorkChainNode, dst: pathlib.Path, decompress: bool = False, include_potcar: bool = False) -> None
   :canonical: aiida_vasp.utils.export._export_workchain

   .. autodoc2-docstring:: aiida_vasp.utils.export._export_workchain

.. py:function:: export_neb(workchain: typing.Any, dst: str | pathlib.Path, decompress: bool = True, include_potcar: bool = True, energy_type: str = 'energy_extrapolated') -> None
   :canonical: aiida_vasp.utils.export.export_neb

   .. autodoc2-docstring:: aiida_vasp.utils.export.export_neb

.. py:function:: copy_from_aiida(name: str, node: aiida.orm.Node, dst: pathlib.Path, decompress: bool = False, exclude: str | None = None) -> None
   :canonical: aiida_vasp.utils.export.copy_from_aiida

   .. autodoc2-docstring:: aiida_vasp.utils.export.copy_from_aiida

.. py:function:: save_all_repository_objects(node: aiida.orm.Node, target_path: pathlib.Path, decompress: bool = False, exclude: str | None = None) -> None
   :canonical: aiida_vasp.utils.export.save_all_repository_objects

   .. autodoc2-docstring:: aiida_vasp.utils.export.save_all_repository_objects