:py:mod:`aiida_vasp.data.archive`
=================================

.. py:module:: aiida_vasp.data.archive

.. autodoc2-docstring:: aiida_vasp.data.archive
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`ArchiveData <aiida_vasp.data.archive.ArchiveData>`
     - .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData
          :summary:

API
~~~

.. py:class:: ArchiveData(*args: typing.Any, **kwargs: typing.Any)
   :canonical: aiida_vasp.data.archive.ArchiveData

   Bases: :py:obj:`aiida.orm.nodes.Data`

   .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData.__init__

   .. py:method:: get_archive() -> typing.Generator[tarfile.TarFile, None, None]
      :canonical: aiida_vasp.data.archive.ArchiveData.get_archive

      .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData.get_archive

   .. py:method:: archive() -> typing.Generator[tarfile.TarFile, None, None]
      :canonical: aiida_vasp.data.archive.ArchiveData.archive

      .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData.archive

   .. py:method:: get_archive_list() -> None
      :canonical: aiida_vasp.data.archive.ArchiveData.get_archive_list

      .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData.get_archive_list

   .. py:method:: add_file(src_abs: str, dst_filename: str | None = None) -> None
      :canonical: aiida_vasp.data.archive.ArchiveData.add_file

      .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData.add_file

   .. py:method:: _make_archive() -> None
      :canonical: aiida_vasp.data.archive.ArchiveData._make_archive

      .. autodoc2-docstring:: aiida_vasp.data.archive.ArchiveData._make_archive

   .. py:method:: store(*args: typing.Any, **kwargs: typing.Any) -> aiida.orm.nodes.Data
      :canonical: aiida_vasp.data.archive.ArchiveData.store