:py:mod:`aiida_vasp.calcs.immigrant`
====================================

.. py:module:: aiida_vasp.calcs.immigrant

.. autodoc2-docstring:: aiida_vasp.calcs.immigrant
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`VaspImmigrant <aiida_vasp.calcs.immigrant.VaspImmigrant>`
     - .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.VaspImmigrant
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`get_incar_input <aiida_vasp.calcs.immigrant.get_incar_input>`
     - .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_incar_input
          :summary:
   * - :py:obj:`get_poscar_input <aiida_vasp.calcs.immigrant.get_poscar_input>`
     - .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_poscar_input
          :summary:
   * - :py:obj:`get_potcar_input <aiida_vasp.calcs.immigrant.get_potcar_input>`
     - .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_potcar_input
          :summary:
   * - :py:obj:`get_kpoints_input <aiida_vasp.calcs.immigrant.get_kpoints_input>`
     - .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_kpoints_input
          :summary:
   * - :py:obj:`get_chgcar_input <aiida_vasp.calcs.immigrant.get_chgcar_input>`
     - .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_chgcar_input
          :summary:
   * - :py:obj:`get_wavecar_input <aiida_vasp.calcs.immigrant.get_wavecar_input>`
     - .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_wavecar_input
          :summary:

API
~~~

.. py:class:: VaspImmigrant(*args, **kwargs)
   :canonical: aiida_vasp.calcs.immigrant.VaspImmigrant

   Bases: :py:obj:`aiida_vasp.calcs.vasp.VaspCalculation`

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.VaspImmigrant

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.VaspImmigrant.__init__

   .. py:method:: define(spec)
      :canonical: aiida_vasp.calcs.immigrant.VaspImmigrant.define
      :classmethod:

   .. py:method:: run()
      :canonical: aiida_vasp.calcs.immigrant.VaspImmigrant.run

   .. py:method:: get_inputs_from_folder(code, remote_workdir: str, **kwargs)
      :canonical: aiida_vasp.calcs.immigrant.VaspImmigrant.get_inputs_from_folder
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.VaspImmigrant.get_inputs_from_folder

   .. py:method:: get_builder_from_folder(code, remote_workdir: str, **kwargs)
      :canonical: aiida_vasp.calcs.immigrant.VaspImmigrant.get_builder_from_folder
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.VaspImmigrant.get_builder_from_folder

   .. py:method:: _add_inputs(transport, remote_path, sandbox_path, inputs, **kwargs)
      :canonical: aiida_vasp.calcs.immigrant.VaspImmigrant._add_inputs
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.VaspImmigrant._add_inputs

.. py:function:: get_incar_input(dir_path)
   :canonical: aiida_vasp.calcs.immigrant.get_incar_input

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_incar_input

.. py:function:: get_poscar_input(dir_path)
   :canonical: aiida_vasp.calcs.immigrant.get_poscar_input

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_poscar_input

.. py:function:: get_potcar_input(dir_path, structure=None, potential_family=None, potential_mapping=None)
   :canonical: aiida_vasp.calcs.immigrant.get_potcar_input

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_potcar_input

.. py:function:: get_kpoints_input(dir_path, structure=None)
   :canonical: aiida_vasp.calcs.immigrant.get_kpoints_input

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_kpoints_input

.. py:function:: get_chgcar_input(dir_path)
   :canonical: aiida_vasp.calcs.immigrant.get_chgcar_input

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_chgcar_input

.. py:function:: get_wavecar_input(dir_path)
   :canonical: aiida_vasp.calcs.immigrant.get_wavecar_input

   .. autodoc2-docstring:: aiida_vasp.calcs.immigrant.get_wavecar_input