StarCluster
===========

.. currentmodule:: clustertools.cluster.cluster

.. autoclass:: StarCluster
   :show-inheritance:

   .. rubric:: Methods Summary

   .. autosummary::

      ~StarCluster.add_action
      ~StarCluster.add_actions
      ~StarCluster.add_binary_stars
      ~StarCluster.add_bse
      ~StarCluster.add_energies
      ~StarCluster.add_nbody6
      ~StarCluster.add_orbit
      ~StarCluster.add_rotation
      ~StarCluster.add_sse
      ~StarCluster.add_stars
      ~StarCluster.analyse
      ~StarCluster.analyze
      ~StarCluster.calc_action
      ~StarCluster.calc_actions
      ~StarCluster.ckin
      ~StarCluster.closest_star
      ~StarCluster.core_relaxation_time
      ~StarCluster.energies
      ~StarCluster.eta_function
      ~StarCluster.find_centre
      ~StarCluster.find_centre_of_density
      ~StarCluster.find_centre_of_mass
      ~StarCluster.half_mass_relaxation_time
      ~StarCluster.initialize_orbit
      ~StarCluster.initialize_orbits
      ~StarCluster.integrate_orbit
      ~StarCluster.integrate_orbits
      ~StarCluster.interpolate_orbit
      ~StarCluster.interpolate_orbits
      ~StarCluster.key_params
      ~StarCluster.mass_function
      ~StarCluster.meq_function
      ~StarCluster.orbit_interpolate
      ~StarCluster.orbital_path
      ~StarCluster.orbital_path_match
      ~StarCluster.orbits_interpolate
      ~StarCluster.rcore
      ~StarCluster.relaxation_time
      ~StarCluster.reset_nbody_scale
      ~StarCluster.return_cluster
      ~StarCluster.rlagrange
      ~StarCluster.rlimiting
      ~StarCluster.rtidal
      ~StarCluster.save_cluster
      ~StarCluster.sortstars
      ~StarCluster.subset
      ~StarCluster.tail_path
      ~StarCluster.tail_path_match
      ~StarCluster.to_WDunits
      ~StarCluster.to_audays
      ~StarCluster.to_center
      ~StarCluster.to_centre
      ~StarCluster.to_cluster
      ~StarCluster.to_galaxy
      ~StarCluster.to_galpy
      ~StarCluster.to_kpckms
      ~StarCluster.to_nbody
      ~StarCluster.to_origin
      ~StarCluster.to_pckms
      ~StarCluster.to_radec
      ~StarCluster.to_sky
      ~StarCluster.to_sudays
      ~StarCluster.to_tail
      ~StarCluster.to_units
      ~StarCluster.ttensor
      ~StarCluster.ttensors
      ~StarCluster.virial_radius
      ~StarCluster.virialize

   .. rubric:: Methods Documentation

   .. automethod:: add_action
   .. automethod:: add_actions
   .. automethod:: add_binary_stars
   .. automethod:: add_bse
   .. automethod:: add_energies
   .. automethod:: add_nbody6
   .. automethod:: add_orbit
   .. automethod:: add_rotation
   .. automethod:: add_sse
   .. automethod:: add_stars
   .. automethod:: analyse
   .. automethod:: analyze
   .. automethod:: calc_action
   .. automethod:: calc_actions
   .. automethod:: ckin
   .. automethod:: closest_star
   .. automethod:: core_relaxation_time
   .. automethod:: energies
   .. automethod:: eta_function
   .. automethod:: find_centre
   .. automethod:: find_centre_of_density
   .. automethod:: find_centre_of_mass
   .. automethod:: half_mass_relaxation_time
   .. automethod:: initialize_orbit
   .. automethod:: initialize_orbits
   .. automethod:: integrate_orbit
   .. automethod:: integrate_orbits
   .. automethod:: interpolate_orbit
   .. automethod:: interpolate_orbits
   .. automethod:: key_params
   .. automethod:: mass_function
   .. automethod:: meq_function
   .. automethod:: orbit_interpolate
   .. automethod:: orbital_path
   .. automethod:: orbital_path_match
   .. automethod:: orbits_interpolate
   .. automethod:: rcore
   .. automethod:: relaxation_time
   .. automethod:: reset_nbody_scale
   .. automethod:: return_cluster
   .. automethod:: rlagrange
   .. automethod:: rlimiting
   .. automethod:: rtidal
   .. automethod:: save_cluster
   .. automethod:: sortstars
   .. automethod:: subset
   .. automethod:: tail_path
   .. automethod:: tail_path_match
   .. automethod:: to_WDunits
   .. automethod:: to_audays
   .. automethod:: to_center
   .. automethod:: to_centre
   .. automethod:: to_cluster
   .. automethod:: to_galaxy
   .. automethod:: to_galpy
   .. automethod:: to_kpckms
   .. automethod:: to_nbody
   .. automethod:: to_origin
   .. automethod:: to_pckms
   .. automethod:: to_radec
   .. automethod:: to_sky
   .. automethod:: to_sudays
   .. automethod:: to_tail
   .. automethod:: to_units
   .. automethod:: ttensor
   .. automethod:: ttensors
   .. automethod:: virial_radius
   .. automethod:: virialize