.. _AbacusSTRUFormat:

stru format
===========

abacus/stru format
==================

Class: :class:`AbacusSTRUFormat <dpdata.plugins.abacus.AbacusSTRUFormat>`

Conversions
-----------

.. _AbacusSTRUFormat_from_system:

Convert from this format to System
``````````````````````````````````

.. py:function:: dpdata.System(file_name, fmt: Literal['stru'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System(file_name, fmt: Literal['abacus/stru'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_stru(file_name) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_abacus_stru(file_name) -> dpdata.system.System
   :noindex:

   
Convert this format to :class:`System`.





:Returns:

    System
        converted system















.. _AbacusSTRUFormat_to_system:

Convert from System to this format
``````````````````````````````````

.. py:function:: dpdata.System.to(fmt: Literal['stru'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to(fmt: Literal['stru'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to_stru(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to_abacus_stru(file_name: 'FileType', frame_idx=0)
   :noindex:

   
Dump the system into ABACUS STRU format file.


:Parameters:

    **file_name** : str
        The output file name

    **frame_idx** : int
        The index of the frame to dump


















.. _AbacusSTRUFormat_to_labeled_system:

Convert from LabeledSystem to this format
`````````````````````````````````````````

.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['stru'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['stru'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_stru(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_abacus_stru(file_name: 'FileType', frame_idx=0)
   :noindex:

   
Dump the system into ABACUS STRU format file.


:Parameters:

    **file_name** : str
        The output file name

    **frame_idx** : int
        The index of the frame to dump