An automatic detection algorithm for stellar streams using a physics-inspired stream model.
The code is open source under a BSD 3-Clause License, which allows you to redistribute and modify the code with moderate limitations. If you use this code for a publication, we kindly request you to cite the following original paper.
- Y. Chen, O. Y. Gnedin, A. M. Price-Whelan, & C. Holm-Hansen (2025) StarStream: Automatic detection algorithm for stellar streams. arXiv:2510.14929, ADS link
We have tested StarStream on 3.9 <= python <= 3.11. However, lower or higher versions may also work. The prerequisites of this package are
numpy
scipy
astropy
agama
To download the packge, git clone the source code from GitHub:
$ git clone https://github.com/ybillchen/StarStream.gitNext, cd the folder and use pip to install it:
$ cd StarStream/
$ pip install -e .The -e command allows you to make changes to the code.
To check if the package is installed correctly, you may run the tests using pytest (make sure it's installed)
$ pytestWe provide example notebooks to demonstrate how to use apply this method to a mock dataset similar to Gaia DR3.
- Y. Chen, O. Y. Gnedin, and A. M. Price-Whelan (2025) StarStream on Gaia: Stream discovery and mass loss rate of globular clusters arXiv:2510.14924, ADS link
Feel free to dive in! Raise an issue or submit pull requests. We recommend you to contribute code following GitHub flow.