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

.. py:module:: aiida_vasp.commands.tools

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`tools <aiida_vasp.commands.tools.tools>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.tools
          :summary:
   * - :py:obj:`export <aiida_vasp.commands.tools.export>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.export
          :summary:
   * - :py:obj:`select_calcjob_from_work <aiida_vasp.commands.tools.select_calcjob_from_work>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.select_calcjob_from_work
          :summary:
   * - :py:obj:`remotecat <aiida_vasp.commands.tools.remotecat>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.remotecat
          :summary:
   * - :py:obj:`remotepull <aiida_vasp.commands.tools.remotepull>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.remotepull
          :summary:
   * - :py:obj:`remotetail <aiida_vasp.commands.tools.remotetail>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.remotetail
          :summary:
   * - :py:obj:`relaxcat <aiida_vasp.commands.tools.relaxcat>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.relaxcat
          :summary:
   * - :py:obj:`tailf_command <aiida_vasp.commands.tools.tailf_command>`
     - .. autodoc2-docstring:: aiida_vasp.commands.tools.tailf_command
          :summary:

API
~~~

.. py:function:: tools() -> None
   :canonical: aiida_vasp.commands.tools.tools

   .. autodoc2-docstring:: aiida_vasp.commands.tools.tools

.. py:function:: export(process, folder: str, decompress: bool, include_potcar: bool) -> None
   :canonical: aiida_vasp.commands.tools.export

   .. autodoc2-docstring:: aiida_vasp.commands.tools.export

.. py:function:: select_calcjob_from_work(func)
   :canonical: aiida_vasp.commands.tools.select_calcjob_from_work

   .. autodoc2-docstring:: aiida_vasp.commands.tools.select_calcjob_from_work

.. py:function:: remotecat(calcjob, fname: str, save_to: str | None) -> None
   :canonical: aiida_vasp.commands.tools.remotecat

   .. autodoc2-docstring:: aiida_vasp.commands.tools.remotecat

.. py:function:: remotepull(calcjob, dest: str, max_size: str | None) -> None
   :canonical: aiida_vasp.commands.tools.remotepull

   .. autodoc2-docstring:: aiida_vasp.commands.tools.remotepull

.. py:function:: remotetail(calcjob, fname: str) -> None
   :canonical: aiida_vasp.commands.tools.remotetail

   .. autodoc2-docstring:: aiida_vasp.commands.tools.remotetail

.. py:function:: relaxcat(workflow, fname: str) -> None
   :canonical: aiida_vasp.commands.tools.relaxcat

   .. autodoc2-docstring:: aiida_vasp.commands.tools.relaxcat

.. py:function:: tailf_command(transport, remotedir: str, fname: str) -> str
   :canonical: aiida_vasp.commands.tools.tailf_command

   .. autodoc2-docstring:: aiida_vasp.commands.tools.tailf_command