:py:mod:`aiida_vasp.protocols`
==============================

.. py:module:: aiida_vasp.protocols

.. autodoc2-docstring:: aiida_vasp.protocols
   :allowtitles:

Submodules
----------

.. toctree::
   :titlesonly:
   :maxdepth: 1

   aiida_vasp.protocols.generator
   aiida_vasp.protocols.pmg

Package Contents
----------------

Classes
~~~~~~~

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

   * - :py:obj:`ProtocolMixin <aiida_vasp.protocols.ProtocolMixin>`
     - .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin
          :summary:

API
~~~

.. py:class:: ProtocolMixin
   :canonical: aiida_vasp.protocols.ProtocolMixin

   .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin

   .. py:attribute:: _protocol_tag
      :canonical: aiida_vasp.protocols.ProtocolMixin._protocol_tag
      :type: str
      :value: 'NULL'

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin._protocol_tag

   .. py:attribute:: _load_root
      :canonical: aiida_vasp.protocols.ProtocolMixin._load_root
      :type: str
      :value: '~/.aiida-vasp/protocols'

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin._load_root

   .. py:method:: _split_protocol_file_name(name)
      :canonical: aiida_vasp.protocols.ProtocolMixin._split_protocol_file_name
      :staticmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin._split_protocol_file_name

   .. py:method:: list_protocol_files(protocol_tag=None) -> list[tuple[str | None, str, pathlib.Path]]
      :canonical: aiida_vasp.protocols.ProtocolMixin.list_protocol_files
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin.list_protocol_files

   .. py:method:: get_protocol_filepath(file_alias: str | None = None) -> pathlib.Path
      :canonical: aiida_vasp.protocols.ProtocolMixin.get_protocol_filepath
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin.get_protocol_filepath

   .. py:method:: get_default_protocol() -> str
      :canonical: aiida_vasp.protocols.ProtocolMixin.get_default_protocol
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin.get_default_protocol

   .. py:method:: get_available_protocols(file_alias=None) -> dict
      :canonical: aiida_vasp.protocols.ProtocolMixin.get_available_protocols
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin.get_available_protocols

   .. py:method:: get_protocol_inputs(protocol: str | None = None, overrides: dict | pathlib.Path | None = None) -> dict
      :canonical: aiida_vasp.protocols.ProtocolMixin.get_protocol_inputs
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin.get_protocol_inputs

   .. py:method:: _load_protocol_file(file_alias=None) -> dict
      :canonical: aiida_vasp.protocols.ProtocolMixin._load_protocol_file
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin._load_protocol_file

   .. py:method:: _check_if_alias(alias: str)
      :canonical: aiida_vasp.protocols.ProtocolMixin._check_if_alias
      :staticmethod:

      .. autodoc2-docstring:: aiida_vasp.protocols.ProtocolMixin._check_if_alias