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

.. py:module:: aiida_vasp.inputset.pmgset

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

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

Classes
~~~~~~~

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

   * - :py:obj:`PymatgenInputSet <aiida_vasp.inputset.pmgset.PymatgenInputSet>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`pmg_kpoints2kpointsdata <aiida_vasp.inputset.pmgset.pmg_kpoints2kpointsdata>`
     - .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.pmg_kpoints2kpointsdata
          :summary:

API
~~~

.. py:class:: PymatgenInputSet(set_name: str, overrides: typing.Optional[typing.Dict] = None, verbose: typing.Optional[bool] = None, pmg_kwargs: typing.Optional[typing.Dict] = None)
   :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet

   Bases: :py:obj:`aiida_vasp.inputset.base.InputSet`

   .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet.__init__

   .. py:attribute:: KNOWN_SETS
      :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet.KNOWN_SETS
      :value: ('MPRelaxSet', 'MITRelaxSet', 'MPScanRelaxSet', 'MP24RelaxSet', 'MPMetalRelaxSet', 'MPHSERelaxSet', ...

      .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet.KNOWN_SETS

   .. py:method:: _load_data() -> None
      :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet._load_data

      .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet._load_data

   .. py:method:: get_input_dict(structure: aiida.orm.StructureData, raw_python: bool = True) -> typing.Union[typing.Dict, aiida.orm.Dict]
      :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_input_dict

      .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_input_dict

   .. py:method:: get_pp_mapping(structure: aiida.orm.StructureData) -> typing.Dict[str, str]
      :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_pp_mapping

      .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_pp_mapping

   .. py:method:: get_potcar_family() -> str
      :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_potcar_family

      .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_potcar_family

   .. py:method:: get_kpoints(structure: aiida.orm.StructureData) -> typing.Optional[aiida.orm.KpointsData]
      :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_kpoints

      .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_kpoints

   .. py:method:: get_kpoints_spacing(structure: aiida.orm.StructureData) -> typing.Optional[float]
      :canonical: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_kpoints_spacing

      .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.PymatgenInputSet.get_kpoints_spacing

.. py:function:: pmg_kpoints2kpointsdata(pmg_kpoints, structure: aiida.orm.StructureData) -> aiida.orm.KpointsData
   :canonical: aiida_vasp.inputset.pmgset.pmg_kpoints2kpointsdata

   .. autodoc2-docstring:: aiida_vasp.inputset.pmgset.pmg_kpoints2kpointsdata