Clustertools: A Python Package for Analyzing Star Cluster Simulations

Abstract

$clustertools$ is a Python package for analyzing star cluster simulations. The package is built around the $StarCluster$ class, which stores all data read in from the snapshot of a given model star cluster. The package contains functions for loading data from commonly used $N$-body codes, generic snapshots, and software for generating initial conditions. All operations and functions within $clustertools$ are then designed to act on a $StarCluster$. $clustertools$ can be used for unit and coordinate transformations, the calculation of key structural and kinematic parameters, analysis of the cluster's orbit and tidal tails, and measuring common cluster properties like its mass function, density profile, and velocity dispersion profile (among others). While originally designed with star clusters in mind, $clustertools$ can be used to study other types of $N$-body systems, including stellar streams and dark matter sub-halos.