:py:mod:`aiida_vasp.utils.pmg`
==============================

.. py:module:: aiida_vasp.utils.pmg

.. autodoc2-docstring:: aiida_vasp.utils.pmg
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`PymatgenAdapator <aiida_vasp.utils.pmg.PymatgenAdapator>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`temporary_folder <aiida_vasp.utils.pmg.temporary_folder>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.temporary_folder
          :summary:
   * - :py:obj:`get_vasprun <aiida_vasp.utils.pmg.get_vasprun>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_vasprun
          :summary:
   * - :py:obj:`get_outcar <aiida_vasp.utils.pmg.get_outcar>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_outcar
          :summary:
   * - :py:obj:`get_incar <aiida_vasp.utils.pmg.get_incar>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_incar
          :summary:
   * - :py:obj:`get_kpoints <aiida_vasp.utils.pmg.get_kpoints>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_kpoints
          :summary:
   * - :py:obj:`get_ibzkpt <aiida_vasp.utils.pmg.get_ibzkpt>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_ibzkpt
          :summary:
   * - :py:obj:`convert_pymatgen_potcar_folder <aiida_vasp.utils.pmg.convert_pymatgen_potcar_folder>`
     - .. autodoc2-docstring:: aiida_vasp.utils.pmg.convert_pymatgen_potcar_folder
          :summary:

API
~~~

.. py:function:: temporary_folder() -> typing.Generator[pathlib.Path, None, None]
   :canonical: aiida_vasp.utils.pmg.temporary_folder

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.temporary_folder

.. py:class:: PymatgenAdapator(node: aiida.orm.CalcJobNode, store_cache: bool = True)
   :canonical: aiida_vasp.utils.pmg.PymatgenAdapator

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.__init__

   .. py:attribute:: FILES
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.FILES
      :value: None

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.FILES

   .. py:attribute:: NO_RECONSTRUCT
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.NO_RECONSTRUCT
      :value: ['vasprun', 'outcar', 'chgcar']

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.NO_RECONSTRUCT

   .. py:method:: _parse_full(file_names: typing.Optional[typing.List[str]] = None) -> None
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator._parse_full

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator._parse_full

   .. py:method:: export_files(dst: str | pathlib.Path) -> None
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.export_files

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.export_files

   .. py:method:: _get_pmg_object(name: str) -> typing.Any
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator._get_pmg_object

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator._get_pmg_object

   .. py:method:: _get_pmg_dict(name: str) -> typing.Dict[str, typing.Any]
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator._get_pmg_dict

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator._get_pmg_dict

   .. py:method:: _flush_cache() -> None
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator._flush_cache

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator._flush_cache

   .. py:method:: __enter__() -> aiida_vasp.utils.pmg.PymatgenAdapator
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.__enter__

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.__enter__

   .. py:method:: __exit__(*args, **kwargs) -> None
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.__exit__

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.__exit__

   .. py:property:: vasprun
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.vasprun
      :type: pymatgen.io.vasp.Vasprun

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.vasprun

   .. py:property:: vasprun_dict
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.vasprun_dict
      :type: typing.Dict[str, typing.Any]

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.vasprun_dict

   .. py:property:: outcar
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.outcar
      :type: pymatgen.io.vasp.Outcar

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.outcar

   .. py:property:: outcar_dict
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.outcar_dict
      :type: typing.Dict[str, typing.Any]

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.outcar_dict

   .. py:property:: poscar
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.poscar
      :type: pymatgen.io.vasp.Poscar

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.poscar

   .. py:property:: poscar_dict
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.poscar_dict
      :type: typing.Dict[str, typing.Any]

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.poscar_dict

   .. py:property:: incar
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.incar
      :type: pymatgen.io.vasp.Incar

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.incar

   .. py:property:: incar_dict
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.incar_dict
      :type: typing.Dict[str, typing.Any]

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.incar_dict

   .. py:property:: kpoints
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.kpoints
      :type: pymatgen.io.vasp.Kpoints

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.kpoints

   .. py:property:: kpoints_dict
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.kpoints_dict
      :type: typing.Dict[str, typing.Any]

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.kpoints_dict

   .. py:property:: ibzkpt
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.ibzkpt
      :type: pymatgen.io.vasp.Kpoints

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.ibzkpt

   .. py:property:: ibzkpt_dict
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.ibzkpt_dict
      :type: typing.Dict[str, typing.Any]

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.ibzkpt_dict

   .. py:method:: save_msonable(name: str, obj: typing.Any) -> None
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.save_msonable

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.save_msonable

   .. py:method:: load_msonable(name: str) -> typing.Any
      :canonical: aiida_vasp.utils.pmg.PymatgenAdapator.load_msonable

      .. autodoc2-docstring:: aiida_vasp.utils.pmg.PymatgenAdapator.load_msonable

.. py:function:: get_vasprun(node: typing.Any, store_cache: bool = True) -> pymatgen.io.vasp.Vasprun
   :canonical: aiida_vasp.utils.pmg.get_vasprun

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_vasprun

.. py:function:: get_outcar(node: typing.Any, store_cache: bool = True) -> pymatgen.io.vasp.Outcar
   :canonical: aiida_vasp.utils.pmg.get_outcar

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_outcar

.. py:function:: get_incar(node: typing.Any, store_cache: bool = True) -> pymatgen.io.vasp.Incar
   :canonical: aiida_vasp.utils.pmg.get_incar

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_incar

.. py:function:: get_kpoints(node: typing.Any, store_cache: bool = True) -> pymatgen.io.vasp.Kpoints
   :canonical: aiida_vasp.utils.pmg.get_kpoints

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_kpoints

.. py:function:: get_ibzkpt(node: typing.Any, store_cache: bool = True) -> pymatgen.io.vasp.Kpoints
   :canonical: aiida_vasp.utils.pmg.get_ibzkpt

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.get_ibzkpt

.. py:function:: convert_pymatgen_potcar_folder(src: pathlib.Path | str, dst: pathlib.Path | str) -> None
   :canonical: aiida_vasp.utils.pmg.convert_pymatgen_potcar_folder

   .. autodoc2-docstring:: aiida_vasp.utils.pmg.convert_pymatgen_potcar_folder