:py:mod:`aiida_vasp.workchains.v2.neb`
======================================

.. py:module:: aiida_vasp.workchains.v2.neb

.. autodoc2-docstring:: aiida_vasp.workchains.v2.neb
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`VaspNEBWorkChain <aiida_vasp.workchains.v2.neb.VaspNEBWorkChain>`
     - .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain
          :summary:

Data
~~~~

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

   * - :py:obj:`VTST_ADDITIONAL_TAGS <aiida_vasp.workchains.v2.neb.VTST_ADDITIONAL_TAGS>`
     - .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VTST_ADDITIONAL_TAGS
          :summary:

API
~~~

.. py:data:: VTST_ADDITIONAL_TAGS
   :canonical: aiida_vasp.workchains.v2.neb.VTST_ADDITIONAL_TAGS
   :value: None

   .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VTST_ADDITIONAL_TAGS

.. py:class:: VaspNEBWorkChain(*args, **kwargs)
   :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain

   Bases: :py:obj:`aiida_vasp.workchains.v2.vasp.VaspWorkChain`

   .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.__init__

   .. py:attribute:: _verbose
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._verbose
      :value: False

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._verbose

   .. py:attribute:: _process_class
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._process_class
      :value: 'CalculationFactory(...)'

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._process_class

   .. py:attribute:: _norm_disp_threshold
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._norm_disp_threshold
      :value: 4.0

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._norm_disp_threshold

   .. py:attribute:: _default_unsupported_parameters
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._default_unsupported_parameters
      :value: None

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._default_unsupported_parameters

   .. py:method:: init_inputs() -> None | aiida.engine.ExitCode
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.init_inputs

   .. py:method:: setup_potcar() -> None
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.setup_potcar

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.setup_potcar

   .. py:method:: check_neb_inputs() -> None | aiida.engine.ExitCode
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.check_neb_inputs

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.check_neb_inputs

   .. py:method:: results() -> aiida.engine.ExitCode | None
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.results

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.results

   .. py:method:: handle_ionic_conv(node: aiida.orm.WorkChainNode) -> aiida.engine.processes.workchains.restart.ProcessHandlerReport | None
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.handle_ionic_conv

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.handle_ionic_conv

   .. py:method:: handle_unfinished_calc_ionic(node: aiida.orm.WorkChainNode) -> aiida.engine.processes.workchains.restart.ProcessHandlerReport | None
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.handle_unfinished_calc_ionic

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.handle_unfinished_calc_ionic

   .. py:method:: _attach_output_structure(node: aiida.orm.WorkChainNode) -> aiida.engine.processes.workchains.restart.ProcessHandlerReport | None
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._attach_output_structure

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._attach_output_structure

   .. py:method:: check_calc_is_finished(node: aiida.orm.CalcJobNode) -> aiida.engine.processes.workchains.restart.ProcessHandlerReport | None
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.check_calc_is_finished

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain.check_calc_is_finished

   .. py:method:: _get_run_status(node)
      :canonical: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._get_run_status

      .. autodoc2-docstring:: aiida_vasp.workchains.v2.neb.VaspNEBWorkChain._get_run_status