.. include:: ../dynamics/references.txt

MockStream
==========

.. currentmodule:: gala.dynamics

.. autoclass:: MockStream
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~MockStream.data
      ~MockStream.pos_components
      ~MockStream.representation_mappings
      ~MockStream.shape
      ~MockStream.vel_components

   .. rubric:: Methods Summary

   .. autosummary::

      ~MockStream.angular_momentum
      ~MockStream.energy
      ~MockStream.from_hdf5
      ~MockStream.from_w
      ~MockStream.get_components
      ~MockStream.kinetic_energy
      ~MockStream.plot
      ~MockStream.potential_energy
      ~MockStream.represent_as
      ~MockStream.to_coord_frame
      ~MockStream.to_frame
      ~MockStream.to_hdf5
      ~MockStream.w

   .. rubric:: Attributes Documentation

   .. autoattribute:: data
   .. autoattribute:: pos_components
   .. autoattribute:: representation_mappings
   .. autoattribute:: shape
   .. autoattribute:: vel_components

   .. rubric:: Methods Documentation

   .. automethod:: angular_momentum
   .. automethod:: energy
   .. automethod:: from_hdf5
   .. automethod:: from_w
   .. automethod:: get_components
   .. automethod:: kinetic_energy
   .. automethod:: plot
   .. automethod:: potential_energy
   .. automethod:: represent_as
   .. automethod:: to_coord_frame
   .. automethod:: to_frame
   .. automethod:: to_hdf5
   .. automethod:: w