:py:mod:`aiida_vasp.inputset.base`
==================================

.. py:module:: aiida_vasp.inputset.base

.. autodoc2-docstring:: aiida_vasp.inputset.base
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`InputSet <aiida_vasp.inputset.base.InputSet>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`get_library_path <aiida_vasp.inputset.base.get_library_path>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.base.get_library_path
          :summary:
   * - :py:obj:`list_inputsets <aiida_vasp.inputset.base.list_inputsets>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.base.list_inputsets
          :summary:
   * - :py:obj:`convert_lowercase <aiida_vasp.inputset.base.convert_lowercase>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.base.convert_lowercase
          :summary:

Data
~~~~

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

   * - :py:obj:`logger <aiida_vasp.inputset.base.logger>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.base.logger
          :summary:
   * - :py:obj:`FELEMS <aiida_vasp.inputset.base.FELEMS>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.base.FELEMS
          :summary:

API
~~~

.. py:data:: logger
   :canonical: aiida_vasp.inputset.base.logger
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: aiida_vasp.inputset.base.logger

.. py:data:: FELEMS
   :canonical: aiida_vasp.inputset.base.FELEMS
   :value: ['La', 'Ce', 'Pr', 'Nd', 'Pm', 'Sm', 'Eu', 'Gd', 'Tb', 'Dy', 'Ho', 'Er', 'Tm', 'Yb', 'Lu', 'Ac', 'Th...

   .. autodoc2-docstring:: aiida_vasp.inputset.base.FELEMS

.. py:function:: get_library_path() -> pathlib.Path
   :canonical: aiida_vasp.inputset.base.get_library_path

   .. autodoc2-docstring:: aiida_vasp.inputset.base.get_library_path

.. py:function:: list_inputsets() -> list[pathlib.Path]
   :canonical: aiida_vasp.inputset.base.list_inputsets

   .. autodoc2-docstring:: aiida_vasp.inputset.base.list_inputsets

.. py:class:: InputSet(set_name, overrides=None, verbose=False)
   :canonical: aiida_vasp.inputset.base.InputSet

   .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet.__init__

   .. py:attribute:: _load_paths
      :canonical: aiida_vasp.inputset.base.InputSet._load_paths
      :value: ()

      .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet._load_paths

   .. py:method:: get_input_dict(structure: aiida.orm.StructureData, raw_python: bool = True) -> aiida.orm.Dict | dict[str, typing.Any]
      :canonical: aiida_vasp.inputset.base.InputSet.get_input_dict

      .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet.get_input_dict

   .. py:method:: _load_data() -> None
      :canonical: aiida_vasp.inputset.base.InputSet._load_data

      .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet._load_data

   .. py:method:: apply_overrides(out_dict: dict[str, typing.Any]) -> None
      :canonical: aiida_vasp.inputset.base.InputSet.apply_overrides

      .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet.apply_overrides

   .. py:method:: get_kpoints(structure: aiida.orm.StructureData, density: float | None = None) -> aiida.orm.KpointsData
      :canonical: aiida_vasp.inputset.base.InputSet.get_kpoints

      .. autodoc2-docstring:: aiida_vasp.inputset.base.InputSet.get_kpoints

.. py:function:: convert_lowercase(indict: dict[str, typing.Any]) -> dict[str, typing.Any]
   :canonical: aiida_vasp.inputset.base.convert_lowercase

   .. autodoc2-docstring:: aiida_vasp.inputset.base.convert_lowercase