:py:mod:`aiida_vasp.parsers.content_parsers.kpoints`
====================================================

.. py:module:: aiida_vasp.parsers.content_parsers.kpoints

.. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`KpointsParser <aiida_vasp.parsers.content_parsers.kpoints.KpointsParser>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`parsevasp_to_aiida <aiida_vasp.parsers.content_parsers.kpoints.parsevasp_to_aiida>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.parsevasp_to_aiida
          :summary:

API
~~~

.. py:class:: KpointsParser(*, handler: typing.TextIO | typing.BinaryIO | None = None, data: aiida.orm.Data | None = None, settings: dict[str, typing.Any] | None = None, options: dict[str, typing.Any] | None = None, raise_errors: bool = False)
   :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser

   Bases: :py:obj:`aiida_vasp.parsers.content_parsers.base.BaseFileParser`

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser.__init__

   .. py:attribute:: DEFAULT_SETTINGS
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser.DEFAULT_SETTINGS
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser.DEFAULT_SETTINGS

   .. py:attribute:: PARSABLE_QUANTITIES
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser.PARSABLE_QUANTITIES
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser.PARSABLE_QUANTITIES

   .. py:method:: _init_from_handler(handler: typing.TextIO) -> None
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._init_from_handler

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._init_from_handler

   .. py:method:: _init_from_data(data: aiida.orm.KpointsData) -> None
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._init_from_data

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._init_from_data

   .. py:property:: kpoints
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser.kpoints
      :type: dict[str, typing.Any] | None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser.kpoints

   .. py:method:: _content_data_to_content_parser() -> typing.Any
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._content_data_to_content_parser

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._content_data_to_content_parser

   .. py:method:: _get_kpointsdict_explicit(kpoints_data: aiida.orm.KpointsData) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._get_kpointsdict_explicit

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._get_kpointsdict_explicit

   .. py:method:: _get_kpointsdict_automatic(kpointsdata: aiida.orm.KpointsData) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._get_kpointsdict_automatic
      :staticmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.KpointsParser._get_kpointsdict_automatic

.. py:function:: parsevasp_to_aiida(kpoints: parsevasp.kpoints.Kpoints, logger: typing.Any) -> dict[str, typing.Any] | None
   :canonical: aiida_vasp.parsers.content_parsers.kpoints.parsevasp_to_aiida

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.kpoints.parsevasp_to_aiida