Stingray 2

Stingray 2: A fast and modern Python library for spectral timing - Published in JOSS (2024)

https://github.com/stingraysoftware/stingray

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 7 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org, zenodo.org
✓
Committers with academic emails
4 of 62 committers (6.5%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

astronomy astrophysics blackhole blackholes data-analysis fourier-analysis fourier-transform hacktoberfest neutronstars pulsars time-series time-series-analysis timeseries x-ray x-ray-binaries

Keywords from Contributors

astropy sunpy solar solar-physics sun mesh exoplanets gravitational-lenses dynamic parallel-computing

Last synced: 6 months ago · JSON representation

Repository

Anything can happen in the next half hour (including spectral timing made easy)!

Basic Info

Host: GitHub
Owner: StingraySoftware
License: mit
Language: Python
Default Branch: main
Homepage: https://stingray.science/stingray
Size: 111 MB

Statistics

Stars: 201
Watchers: 19
Forks: 169
Open Issues: 68
Releases: 12

Topics

astronomy astrophysics blackhole blackholes data-analysis fourier-analysis fourier-transform hacktoberfest neutronstars pulsars time-series time-series-analysis timeseries x-ray x-ray-binaries

Created over 10 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct

README.rst

========
Stingray
========

.. csv-table::
   :header: "Usage", "Release", "Development", "Community"
   :widths: 50, 50, 50, 50

   |Python version|, |GitHub release|, |Build Status Master|, |Slack|
   |Docs|, |joss|, |Repo status|,  |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`_.

Related Packages
----------------

- `HENDRICS `_ provides a set of command-line scripts which use Stingray to perform quick-look spectral timing analysis of X-ray data.
- `DAVE `_ is a graphical user interface built on top of Stingray.

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.

Copyright & Licensing
---------------------

All content © 2024 The Authors.
The code is distributed under the MIT license; see `LICENSE.rst `_ for details.

.. |Python version| image:: https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/stingraysoftware/stingray/main/pyproject.toml
   :alt: Python Version from PEP 621 TOML
.. |Build Status Master| image:: https://github.com/StingraySoftware/stingray/workflows/CI%20Tests/badge.svg
   :target: https://github.com/StingraySoftware/stingray/actions/
.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
   :target: https://docs.stingray.science/
.. |Slack| image:: https://img.shields.io/badge/Join%20Our%20Community-Slack-blue
   :target: https://join.slack.com/t/stingraysoftware/shared_invite/zt-49kv4kba-mD1Y~s~rlrOOmvqM7mZugQ
.. |Coverage Status Master| image:: https://codecov.io/gh/StingraySoftware/stingray/branch/master/graph/badge.svg?token=FjWeFfhU9F
   :target: https://codecov.io/gh/StingraySoftware/stingray
.. |GitHub release| image:: https://img.shields.io/github/v/release/StingraySoftware/stingray
   :target: https://github.com/StingraySoftware/stingray/releases/latest
.. |joss| image:: https://joss.theoj.org/papers/10.21105/joss.07389/status.svg
   :target: https://doi.org/10.21105/joss.07389
.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1490116.svg
   :target: https://doi.org/10.5281/zenodo.1490116
.. |Repo status| image:: https://www.repostatus.org/badges/latest/active.svg
   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
   :target: https://www.repostatus.org/#active
.. |License| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
.. |pyOpenSci Peer-Reviewed| image:: https://pyopensci.org/badges/peer-reviewed.svg
   :target: https://github.com/pyOpenSci/software-submission/issues/201

.. _Astropy: https://www.github.com/astropy/astropy
.. _Issues: https://www.github.com/stingraysoftware/stingray/issues
.. _Issue: https://www.github.com/stingraysoftware/stingray/issues
.. _pull request: https://github.com/StingraySoftware/stingray/pulls

Owner

Name: Stingray
Login: StingraySoftware
Kind: organization

Website: https://stingray.science
Repositories: 9
Profile: https://github.com/StingraySoftware

Next-generation spectral-timing software for astronomy applications and beyond.

JOSS Publication

stingray: A modern Python library for spectral timing

Published

June 11, 2019

DOI

10.21105/joss.01393

Volume 4, Issue 38, Page 1393

Authors

Daniela Huppenkothen

DIRAC Institute, Department of Astronomy, University of Washington, 3910 15th Ave NE, Seattle, WA 98195

Matteo Bachetti

INAF-Osservatorio Astronomico di Cagliari, via della Scienza 5, I-09047 Selargius (CA), Italy

Abigail Stevens

Department of Physics & Astronomy, Michigan State University, 567 Wilson Road, East Lansing, MI 48824, USA, Department of Astronomy, University of Michigan, 1085 South University Avenue, Ann Arbor, MI 48109, USA

Simone Migliari
ESAC/ESA, XMM-Newton Science Operations Centre, Camino Bajo del Castillo s/n, Urb. Villafranca del Castillo, 28692, Villanueva de la Caada, Madrid, Spain, Timelab Technologies Ltd., 20-22 Wenlock Road, London N1 7GU, United Kingdom

Paul Balm
Timelab Technologies Ltd., 20-22 Wenlock Road, London N1 7GU, United Kingdom

Omar Hammad
AinShams University, Egypt

Usman Mahmood Khan
Department of Computer Science, North Carolina State University, Raleigh, USA

Himanshu Mishra
Indian Institute of Technology, Kharagpur West Bengal, India 721302

Haroon Rashid
National University of Sciences and Technology (NUST), Islamabad 44000, Pakistan

Swapnil Sharma
Indian Institute of Technology Mandi, Mandi, Himachal Pradesh, India

Evandro Martinez Ribeiro
Kapteyn Astronomical Institute, University of Groningen, P.O. Box 800, NL-9700 AV Groningen, The Netherlands

Ricardo Valles Blanco
Timelab Technologies Ltd., 20-22 Wenlock Road, London N1 7GU, United Kingdom

Editor

Arfon Smith

Papers & Mentions

Total mentions: 1

Proteolysis of the endothelial cell protein C receptor by neutrophil proteinase 3

DOI: 10.1111/j.1538-7836.2007.02480.x
OpenAlex ID: https://openalex.org/W2029002278
Published: May 2007

Last synced: 4 months ago

GitHub Events

Total

Create event: 48
Release event: 1
Issues event: 40
Watch event: 31
Delete event: 36
Issue comment event: 190
Push event: 114
Pull request review event: 93
Pull request review comment event: 72
Pull request event: 95
Fork event: 31

Last Year

Create event: 48
Release event: 1
Issues event: 40
Watch event: 31
Delete event: 36
Issue comment event: 191
Push event: 114
Pull request review event: 93
Pull request review comment event: 72
Pull request event: 95
Fork event: 31

Committers

Last synced: 7 months ago

All Time

Total Commits: 3,587
Total Committers: 62
Avg Commits per committer: 57.855
Development Distribution Score (DDS): 0.433

Past Year

Commits: 221
Committers: 9
Avg Commits per committer: 24.556
Development Distribution Score (DDS): 0.271

Top Committers

Name	Email	Commits
Matteo Bachetti	m**o@m**t	2,035
Daniela Huppenkothen	d**k@u**u	231
Daniela Huppenkothen	d**n@n**u	229
Usman Mahmood	u**g@g**m	128
Himanshu Mishra	h**t@g**m	127
John Swinbank	j**n@s**g	84
Swapnil Sharma	s**6@g**m	79
Amogh Desai	a**9@g**m	69
Abbie Stevens	a**v@g**m	65
Haroon Rashid	h**5@g**m	65
Evandro M. Ribeiro	e**o@g**m	51
Mihir Tripathi	m**7@g**m	49
Gaurav17Joshi	g**7@g**m	48
Gullo	g**o@g**m	33
Abigail Stevens	A**s@u**l	30
Brigitta Sipocz	b**z@g**m	27
pupperemeritus	p**9@p**m	27
Dhruv Vats	d**s@g**m	17
spranav1205	s**5@g**m	16
Guglielmo Mastroserio	m**k@g**m	14
tappina	m**m@g**m	14
adnan	a**2@g**m	13
Yash Bhargava	y**2@g**m	12
Sauravroy34	s**9@g**m	9
omargamal8	o**h@h**m	8
Megan Davis	d**1@m**u	8
Stuart Mumford	s**t@c**m	7
devanshshukla99	d**9@o**m	6
_youteakay	b**k@g**m	5
Riccardo Campana	r**a@g**m	5
and 32 more...

Committer Domains (Top 20 + Academic)

iiits.in: 1 polynomial.org: 1 yahoo.de: 1 o2.pl: 1 github.com: 1 cadair.com: 1 msu.edu: 1 uva.nl: 1 swinbank.org: 1 nyu.edu: 1 uw.edu: 1 matteobachetti.it: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 111
Total pull requests: 275
Average time to close issues: 9 months
Average time to close pull requests: about 1 month
Total issue authors: 48
Total pull request authors: 41
Average comments per issue: 2.39
Average comments per pull request: 2.35
Merged pull requests: 173
Bot issues: 0
Bot pull requests: 4

Past Year

Issues: 38
Pull requests: 108
Average time to close issues: 17 days
Average time to close pull requests: 20 days
Issue authors: 19
Pull request authors: 18
Average comments per issue: 0.89
Average comments per pull request: 1.81
Merged pull requests: 45
Bot issues: 0
Bot pull requests: 2

View more stats

Top Authors

Issue Authors

matteobachetti (26)
dhuppenkothen (17)
matteolucchini1 (6)
taldcroft (6)
andresgur (4)
ankitkhushwaha (4)
gabrielb09 (3)
AnonymousCodes911 (2)
pier-astro (2)
pupperemeritus (2)
pllim (2)
davis191 (1)
yuzl00 (1)
swapsha96 (1)
jscargle (1)

Pull Request Authors

matteobachetti (129)
ankitkhushwaha (17)
Sauravroy34 (15)
mgullik (9)
Gaurav17Joshi (8)
dhuppenkothen (8)
pupperemeritus (8)
aDNAn-itis (7)
kashish2210 (6)
Anithpavan (6)
dependabot[bot] (4)
spranav1205 (4)
capy-on-caffeine (4)
mihirtripathi97 (4)
abigailStev (3)

Top Labels

Issue Labels

help wanted (45) bug (23) docs (11) GSoC (11) good first issue (10) feature (9) enhancement (9) low-priority (6) medium-priority (5) question (1) wontfix (1)

Pull Request Labels

no-changelog-entry-needed (44) hacktoberfest (6) hacktoberfest-accepted (6) dependencies (4) feature (2) python (2) enhancement (1) ready-for-review (1) no-changelog-needed (1)

Packages

Total packages: 2
Total downloads:
- pypi 1,593 last-month

Total dependent packages: 3
(may contain duplicates)
Total dependent repositories: 6
(may contain duplicates)
Total versions: 34
Total maintainers: 3

pypi.org: stingray

Time Series Methods For Astronomical X-ray Data

Documentation: https://stingray.readthedocs.io/
License: MIT
Latest release: 2.2.9
published 6 months ago

Versions: 27
Dependent Packages: 2
Dependent Repositories: 6
Downloads: 1,593 Last month

Rankings

Dependent packages count: 4.7%

Dependent repos count: 6.0%

Average: 7.5%

Downloads: 11.7%

Maintainers (3)

dhuppenkothen mbachett alstev

Last synced: 6 months ago

conda-forge.org: stingray

This Astropy-affiliated software package merges existing efforts for a timing package in Python and provides the basis for developing spectral-timing analysis tools. It is structured with the best guidelines for modern open-source programming, following the example of Astropy.

Homepage: http://github.com/StingraySoftware/stingray
License: MIT
Latest release: 1.1.1
published over 3 years ago

Versions: 7
Dependent Packages: 1
Dependent Repositories: 0

Rankings

Forks count: 15.6%

Average: 26.6%

Stargazers count: 28.0%

Dependent packages count: 28.8%

Dependent repos count: 34.0%

Last synced: 6 months ago

Dependencies

.github/workflows/ci_test.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
codecov/codecov-action v3 composite

.github/workflows/publish_docs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
crazy-max/ghaction-github-pages v3 composite

.github/workflows/check-changelog.yml actions

actions/checkout v3 composite

.github/workflows/check_docs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

pyproject.toml pypi

setup.py pypi

Stingray 2

Science Score: 95.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

JOSS Publication

stingray: A modern Python library for spectral timing

Authors

Editor

Tags

Papers & Mentions

Proteolysis of the endothelial cell protein C receptor by neutrophil proteinase 3

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: stingray

Rankings

Maintainers (3)

conda-forge.org: stingray

Rankings

Dependencies