.. _VASPStringFormat:

vasp/string format
==================

Class: :class:`VASPStringFormat <dpdata.plugins.vasp.VASPStringFormat>`

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

.. _VASPStringFormat_to_system:

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

.. py:function:: dpdata.System.to(fmt: Literal['vasp/string'], frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to_vasp_string(frame_idx=0)
   :noindex:

   
Dump the system in vasp POSCAR format string.


:Parameters:

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


















.. _VASPStringFormat_to_labeled_system:

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

.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['vasp/string'], frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_vasp_string(frame_idx=0)
   :noindex:

   
Dump the system in vasp POSCAR format string.


:Parameters:

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