View on GitHub

Stingray

Next-generation spectral-timing software

Stingray is a community-developed spectral-timing software package in Python for astrophysical data, and is an Astropy Affiliated Package.

The vision

There are a number of official software packages for X-ray spectral fitting (e.g., XSPEC, ISIS, Sherpa). Such widely-used, flexible, and standard software packages did not exist for X-ray timing, so it was mostly done with custom, proprietary software. During the 2016 workshop The X-ray Spectral-Timing Revolution, a group of X-ray astronomers and developers decided on a common platform to develop a new software package. This software package, Stingray, provides the basis for developing spectral-timing analysis tools, and is structured with the Astropy guidelines for modern open-source scientific programming. Stingray has a scripting interface (HENDRICS), an affiliated GUI (DAVE), and a public API for power-users. Our goal is to provide the community with a package that eases the learning curve for advanced spectral-timing techniques, with a correct statistical framework.

How to download Stingray

Stingray can be downloaded and installed via the Python Package Index, conda, or the source code straight from GitHub. The procedures for each of these routes are in the docs!

How to get involved

We encourage you to get involved with Stingray in any way you can! First, read through the README and docs. Then, fork the stingray and notebooks repositories (if you need a primer on GitHub and git version control, look here) and work your way through the Jupyter notebook tutorials for the main modules. Once you've familiarized yourself with the basics of Stingray, go to the Stingray issues page and try to tackle one! Other ways to get involved are outlined on the project ideas page, along with some astrophysical background/motivation.

For organizing and coordinating the software development, we have a Slack workspace -- please use this link for Slack or send one of us an email to join. Students interested in Stingray projects for Google Summer of Code, please join our Slack and check out the pinned posts!

Citing Stingray

If you use Stingray, please cite us in papers and other projects! Citations are still the main currency of the academic world, and pointing to citations is the best way to help us ensure that Stingray continues to be supported and we can continue working on it!
Huppenkothen et al. 2019, ApJ, submitted (arXiv:1901.07681)
ascl:1608.001

Presentations

Acknowledgements

Thank you to JetBrains for the free use of PyCharm.

Stingray participated in the Google Summer of Code in 2018 under Open Astronomy, in 2017 under the Python Software Foundation, and in 2016 under Timelab.

Python logo PyCharm logo Google Summer of Code GSoC logo