Skip to main content

Stingray

Usage

Release

Development

Community

Python Version from PEP 621 TOML

GitHub release

Build Status Master

Slack

Docs

joss

Project Status: Active – The project has reached a stable, usable state and is being actively developed.

pyOpenSci Peer-Reviewed

License

doi

Coverage Status Master

X-Ray Spectral Timing Made Easy

Stingray is a spectral-timing software package for astrophysical X-ray (and other) data. Stingray merges existing efforts for a (spectral-)timing package in Python, and is structured with the best guidelines for modern open-source programming, following the example of Astropy.

It provides:

  • a library of time series methods, including power spectra, cross spectra, covariance spectra, lags, and so on;

  • a set of scripts to load FITS data files from different missions;

  • a light curve and event list simulator, with the ability to simulate different kinds of variability and more complicated phenomena based on the impulse response of given physical events (e.g. reverberation).

There are a number of official software packages for X-ray spectral fitting (Xspec, ISIS, Sherpa, …). However, an equivalent widely-used package does not exist for X-ray timing: to date, that has generally been done with custom software. Stingray aims not only to fill that gap, but also to provide implementations of the most advanced spectral timing techniques available in the literature. The ultimate goal of this project is to provide the community with a package that eases the learning curve for the advanced spectral timing techniques with a correct statistical framework.

More details of current and planned capabilities are available in the Stingray documentation.

Installation and Testing

Stingray can be installed via conda, pip, or directly from the source repository itself. Our documentation provides comprehensive installation instructions.

After installation, it’s a good idea to run the test suite. We use py.test and tox for testing, and, again, our documentation provides step-by-step instructions.

Documentation

Stingray’s documentation can be found at https://docs.stingray.science/.

Getting In Touch, and Getting Involved

We welcome contributions and feedback, and we need your help! The best way to get in touch is via the issues_ page. We’re especially interested in hearing from you:

  • If something breaks;

  • If you spot missing functionality, find the API unintuitive, or have suggestions for future development;

  • If you have your own code implementing any of the methods provided Stingray and it produces different answers.

Even better: if you have code you’d be willing to contribute, please send a pull request or open an issue.

Citing Stingray

If you find this package useful in your research, please provide appropriate acknowledgement and citation. Our documentation gives further guidance, including links to appropriate papers and convenient BibTeX entries.

Release files for stingray 2.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stingray 2.3.2
File Size Uploaded
stingray-2.3.2.tar.gz 72.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for stingray 2.3.2
File Interpreter ABI Platform
stingray-2.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 127.9 MB

Release files / stingray-2.3.2.tar.gz

Download URL stingray-2.3.2.tar.gz
Size 72.3 MB
Tags Source
SHA-256 checksum
How to use checksums
ac1f7838612600f4c330967064118f5a85515f514c1ddaab3e7e0ed5dbf4ea1b
BLAKE2b-256 checksum
How to use checksums
eeee29d84ad95100b94980ebf1d203f32c4d8fe70ff379434192bbc1f529a896
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release files / stingray-2.3.2-py3-none-any.whl

Download URL stingray-2.3.2-py3-none-any.whl
Size 55.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
310a4772d79b9b658ac8027646f84ba85fd9150da043c054a5de2644e563357b
BLAKE2b-256 checksum
How to use checksums
432fa63cfa31a0f85f2563776ef84bf5785560027c60fc88ddc2209556ef8f46
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page