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

.. py:module:: aiida_vasp.parsers.content_parsers.chgcar

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

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

Classes
~~~~~~~

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

   * - :py:obj:`ChgcarParser <aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser
          :summary:

API
~~~

.. py:class:: ChgcarParser(*, 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.chgcar.ChgcarParser

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

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.__init__

   .. py:attribute:: DEFAULT_SETTINGS
      :canonical: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.DEFAULT_SETTINGS
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.DEFAULT_SETTINGS

   .. py:attribute:: PARSABLE_QUANTITIES
      :canonical: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.PARSABLE_QUANTITIES
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.PARSABLE_QUANTITIES

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

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser._init_from_handler

   .. py:property:: charge_density
      :canonical: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.charge_density

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.charge_density

   .. py:property:: magnetization_density
      :canonical: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.magnetization_density

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.chgcar.ChgcarParser.magnetization_density