:py:mod:`aiida_lammps.data.trajectory`
======================================

.. py:module:: aiida_lammps.data.trajectory

.. autodoc2-docstring:: aiida_lammps.data.trajectory
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`LammpsTrajectory <aiida_lammps.data.trajectory.LammpsTrajectory>`
     - .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory
          :summary:

API
~~~

.. py:class:: LammpsTrajectory(fileobj=None, aliases=None, **kwargs)
   :canonical: aiida_lammps.data.trajectory.LammpsTrajectory

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

   .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.__init__

   .. py:method:: set_from_fileobj(fileobj, aliases=None)
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.set_from_fileobj

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.set_from_fileobj

   .. py:property:: number_steps
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.number_steps

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.number_steps

   .. py:property:: time_steps
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.time_steps

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.time_steps

   .. py:property:: number_atoms
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.number_atoms

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.number_atoms

   .. py:property:: field_names
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.field_names

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.field_names

   .. py:property:: aliases
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.aliases

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.aliases

   .. py:method:: get_step_string(step_idx)
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.get_step_string

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.get_step_string

   .. py:method:: get_step_data(step_idx)
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.get_step_data

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.get_step_data

   .. py:method:: iter_step_strings(steps=None)
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.iter_step_strings

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.iter_step_strings

   .. py:method:: get_step_structure(step_idx: int, symbol_field: str = 'element', position_fields: tuple = ('x', 'y', 'z'), original_structure: aiida.orm.StructureData = None) -> aiida.orm.StructureData
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.get_step_structure

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.get_step_structure

   .. py:method:: write_as_lammps(handle, steps=None)
      :canonical: aiida_lammps.data.trajectory.LammpsTrajectory.write_as_lammps

      .. autodoc2-docstring:: aiida_lammps.data.trajectory.LammpsTrajectory.write_as_lammps
