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

.. py:module:: aiida_vasp.parsers.content_parsers.poscar

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

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

Classes
~~~~~~~

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

   * - :py:obj:`PoscarParser <aiida_vasp.parsers.content_parsers.poscar.PoscarParser>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser
          :summary:

Functions
~~~~~~~~~

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

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

API
~~~

.. py:class:: PoscarParser(*, precision=12, **kwargs)
   :canonical: aiida_vasp.parsers.content_parsers.poscar.PoscarParser

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

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.__init__

   .. py:attribute:: DEFAULT_SETTINGS
      :canonical: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.DEFAULT_SETTINGS
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.DEFAULT_SETTINGS

   .. py:attribute:: PARSABLE_QUANTITIES
      :canonical: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.PARSABLE_QUANTITIES
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.PARSABLE_QUANTITIES

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

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser._init_from_handler

   .. py:method:: _init_from_data(data: aiida.orm.StructureData) -> None
      :canonical: aiida_vasp.parsers.content_parsers.poscar.PoscarParser._init_from_data

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser._init_from_data

   .. py:property:: structure
      :canonical: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.structure
      :type: dict[str, typing.Any]

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.structure

   .. py:method:: _content_data_to_content_parser() -> aiida_vasp.parsers.content_parsers.poscar.PoscarParser
      :canonical: aiida_vasp.parsers.content_parsers.poscar.PoscarParser._content_data_to_content_parser

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser._content_data_to_content_parser

   .. py:method:: transform_to_bool(value: str | int) -> bool
      :canonical: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.transform_to_bool

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.poscar.PoscarParser.transform_to_bool

.. py:function:: parsevasp_to_aiida(poscar: parsevasp.poscar.Poscar) -> dict[str, typing.Any]
   :canonical: aiida_vasp.parsers.content_parsers.poscar.parsevasp_to_aiida

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